@vercel/sdk 1.10.0 → 1.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (290) hide show
  1. package/bin/mcp-server.js +3601 -3879
  2. package/bin/mcp-server.js.map +59 -59
  3. package/docs/sdks/accessgroups/README.md +11 -0
  4. package/docs/sdks/aliases/README.md +7 -1
  5. package/docs/sdks/artifacts/README.md +6 -0
  6. package/docs/sdks/authentication/README.md +5 -0
  7. package/docs/sdks/certs/README.md +4 -0
  8. package/docs/sdks/checks/README.md +5 -0
  9. package/docs/sdks/deployments/README.md +18 -0
  10. package/docs/sdks/dns/README.md +4 -0
  11. package/docs/sdks/domains/README.md +10 -0
  12. package/docs/sdks/edgeconfig/README.md +17 -0
  13. package/docs/sdks/environment/README.md +5 -0
  14. package/docs/sdks/integrations/README.md +4 -0
  15. package/docs/sdks/logdrains/README.md +3 -0
  16. package/docs/sdks/logs/README.md +1 -0
  17. package/docs/sdks/marketplace/README.md +20 -0
  18. package/docs/sdks/projectmembers/README.md +3 -0
  19. package/docs/sdks/projects/README.md +24 -0
  20. package/docs/sdks/rollingrelease/README.md +7 -0
  21. package/docs/sdks/security/README.md +8 -0
  22. package/docs/sdks/teams/README.md +13 -0
  23. package/docs/sdks/user/README.md +3 -0
  24. package/docs/sdks/webhooks/README.md +4 -0
  25. package/esm/__tests__/aliases.test.js +16 -16
  26. package/esm/__tests__/aliases.test.js.map +1 -1
  27. package/esm/__tests__/security.test.js +13 -1
  28. package/esm/__tests__/security.test.js.map +1 -1
  29. package/esm/funcs/aliasesGetAlias.d.ts +2 -2
  30. package/esm/funcs/aliasesGetAlias.d.ts.map +1 -1
  31. package/esm/funcs/aliasesGetAlias.js +3 -2
  32. package/esm/funcs/aliasesGetAlias.js.map +1 -1
  33. package/esm/funcs/checksRerequestCheck.js +1 -0
  34. package/esm/funcs/checksRerequestCheck.js.map +1 -1
  35. package/esm/funcs/domainsBuyDomain.js +2 -2
  36. package/esm/funcs/domainsBuyDomain.js.map +1 -1
  37. package/esm/funcs/domainsGetDomainConfig.js +2 -2
  38. package/esm/funcs/domainsGetDomainConfig.js.map +1 -1
  39. package/esm/funcs/domainsPatchDomain.js +2 -2
  40. package/esm/funcs/domainsPatchDomain.js.map +1 -1
  41. package/esm/funcs/edgeConfigPatchEdgeConfigItems.js +2 -3
  42. package/esm/funcs/edgeConfigPatchEdgeConfigItems.js.map +1 -1
  43. package/esm/funcs/marketplaceUpdateInstallationIntegrationEdgeConfig.js +2 -2
  44. package/esm/funcs/marketplaceUpdateInstallationIntegrationEdgeConfig.js.map +1 -1
  45. package/esm/funcs/projectsAcceptProjectTransferRequest.js +2 -2
  46. package/esm/funcs/projectsAcceptProjectTransferRequest.js.map +1 -1
  47. package/esm/funcs/projectsCreateProject.js +2 -2
  48. package/esm/funcs/projectsCreateProject.js.map +1 -1
  49. package/esm/funcs/teamsPatchTeam.js +2 -2
  50. package/esm/funcs/teamsPatchTeam.js.map +1 -1
  51. package/esm/lib/config.d.ts +3 -3
  52. package/esm/lib/config.js +3 -3
  53. package/esm/mcp-server/mcp-server.js +1 -1
  54. package/esm/mcp-server/server.js +1 -1
  55. package/esm/models/acceptprojecttransferrequestop.d.ts +176 -2
  56. package/esm/models/acceptprojecttransferrequestop.d.ts.map +1 -1
  57. package/esm/models/acceptprojecttransferrequestop.js +176 -2
  58. package/esm/models/acceptprojecttransferrequestop.js.map +1 -1
  59. package/esm/models/addbypassipop.d.ts +38 -38
  60. package/esm/models/addbypassipop.d.ts.map +1 -1
  61. package/esm/models/addbypassipop.js +44 -42
  62. package/esm/models/addbypassipop.js.map +1 -1
  63. package/esm/models/authtoken.d.ts +10 -4
  64. package/esm/models/authtoken.d.ts.map +1 -1
  65. package/esm/models/authtoken.js +6 -4
  66. package/esm/models/authtoken.js.map +1 -1
  67. package/esm/models/authuser.d.ts +54 -0
  68. package/esm/models/authuser.d.ts.map +1 -1
  69. package/esm/models/authuser.js +34 -0
  70. package/esm/models/authuser.js.map +1 -1
  71. package/esm/models/canceldeploymentop.d.ts +385 -148
  72. package/esm/models/canceldeploymentop.d.ts.map +1 -1
  73. package/esm/models/canceldeploymentop.js +363 -148
  74. package/esm/models/canceldeploymentop.js.map +1 -1
  75. package/esm/models/createcustomenvironmentop.d.ts +3 -3
  76. package/esm/models/createcustomenvironmentop.js +1 -1
  77. package/esm/models/createcustomenvironmentop.js.map +1 -1
  78. package/esm/models/createdeploymentop.d.ts +604 -344
  79. package/esm/models/createdeploymentop.d.ts.map +1 -1
  80. package/esm/models/createdeploymentop.js +501 -274
  81. package/esm/models/createdeploymentop.js.map +1 -1
  82. package/esm/models/createlogdrainop.d.ts +2 -2
  83. package/esm/models/createlogdrainop.d.ts.map +1 -1
  84. package/esm/models/createlogdrainop.js +2 -2
  85. package/esm/models/createlogdrainop.js.map +1 -1
  86. package/esm/models/createprojectenvop.d.ts +6 -6
  87. package/esm/models/createprojectenvop.js +2 -2
  88. package/esm/models/createprojectenvop.js.map +1 -1
  89. package/esm/models/createprojectop.d.ts +378 -797
  90. package/esm/models/createprojectop.d.ts.map +1 -1
  91. package/esm/models/createprojectop.js +344 -718
  92. package/esm/models/createprojectop.js.map +1 -1
  93. package/esm/models/createwebhookop.d.ts +12 -0
  94. package/esm/models/createwebhookop.d.ts.map +1 -1
  95. package/esm/models/createwebhookop.js +4 -0
  96. package/esm/models/createwebhookop.js.map +1 -1
  97. package/esm/models/editprojectenvop.d.ts +3 -3
  98. package/esm/models/editprojectenvop.js +1 -1
  99. package/esm/models/editprojectenvop.js.map +1 -1
  100. package/esm/models/exchangessotokenop.d.ts +4 -4
  101. package/esm/models/exchangessotokenop.d.ts.map +1 -1
  102. package/esm/models/exchangessotokenop.js +4 -4
  103. package/esm/models/exchangessotokenop.js.map +1 -1
  104. package/esm/models/filterprojectenvsop.d.ts +9 -9
  105. package/esm/models/filterprojectenvsop.js +3 -3
  106. package/esm/models/filterprojectenvsop.js.map +1 -1
  107. package/esm/models/getaliasop.d.ts +0 -555
  108. package/esm/models/getaliasop.d.ts.map +1 -1
  109. package/esm/models/getaliasop.js +0 -449
  110. package/esm/models/getaliasop.js.map +1 -1
  111. package/esm/models/getbypassipop.d.ts +55 -179
  112. package/esm/models/getbypassipop.d.ts.map +1 -1
  113. package/esm/models/getbypassipop.js +59 -221
  114. package/esm/models/getbypassipop.js.map +1 -1
  115. package/esm/models/getcustomenvironmentop.d.ts +3 -3
  116. package/esm/models/getcustomenvironmentop.js +1 -1
  117. package/esm/models/getcustomenvironmentop.js.map +1 -1
  118. package/esm/models/getdeploymentop.d.ts +847 -366
  119. package/esm/models/getdeploymentop.d.ts.map +1 -1
  120. package/esm/models/getdeploymentop.js +772 -332
  121. package/esm/models/getdeploymentop.js.map +1 -1
  122. package/esm/models/getdeploymentsop.d.ts +3 -0
  123. package/esm/models/getdeploymentsop.d.ts.map +1 -1
  124. package/esm/models/getdeploymentsop.js +1 -0
  125. package/esm/models/getdeploymentsop.js.map +1 -1
  126. package/esm/models/getfirewallconfigop.d.ts +3 -0
  127. package/esm/models/getfirewallconfigop.d.ts.map +1 -1
  128. package/esm/models/getfirewallconfigop.js +1 -0
  129. package/esm/models/getfirewallconfigop.js.map +1 -1
  130. package/esm/models/getintegrationlogdrainsop.d.ts +2 -2
  131. package/esm/models/getintegrationlogdrainsop.d.ts.map +1 -1
  132. package/esm/models/getintegrationlogdrainsop.js +4 -2
  133. package/esm/models/getintegrationlogdrainsop.js.map +1 -1
  134. package/esm/models/getprojectmembersop.d.ts +3 -0
  135. package/esm/models/getprojectmembersop.d.ts.map +1 -1
  136. package/esm/models/getprojectmembersop.js +1 -0
  137. package/esm/models/getprojectmembersop.js.map +1 -1
  138. package/esm/models/getprojectsop.d.ts +218 -643
  139. package/esm/models/getprojectsop.d.ts.map +1 -1
  140. package/esm/models/getprojectsop.js +197 -573
  141. package/esm/models/getprojectsop.js.map +1 -1
  142. package/esm/models/getrecordsop.d.ts +8 -0
  143. package/esm/models/getrecordsop.d.ts.map +1 -1
  144. package/esm/models/getrecordsop.js +8 -0
  145. package/esm/models/getrecordsop.js.map +1 -1
  146. package/esm/models/getteammembersop.d.ts +6 -0
  147. package/esm/models/getteammembersop.d.ts.map +1 -1
  148. package/esm/models/getteammembersop.js +2 -0
  149. package/esm/models/getteammembersop.js.map +1 -1
  150. package/esm/models/getv9projectsidornamecustomenvironmentsop.d.ts +3 -3
  151. package/esm/models/getv9projectsidornamecustomenvironmentsop.js +1 -1
  152. package/esm/models/getv9projectsidornamecustomenvironmentsop.js.map +1 -1
  153. package/esm/models/getwebhookop.d.ts +6 -0
  154. package/esm/models/getwebhookop.d.ts.map +1 -1
  155. package/esm/models/getwebhookop.js +2 -0
  156. package/esm/models/getwebhookop.js.map +1 -1
  157. package/esm/models/getwebhooksop.d.ts +15 -0
  158. package/esm/models/getwebhooksop.d.ts.map +1 -1
  159. package/esm/models/getwebhooksop.js +5 -0
  160. package/esm/models/getwebhooksop.js.map +1 -1
  161. package/esm/models/inviteusertoteamop.d.ts +33 -0
  162. package/esm/models/inviteusertoteamop.d.ts.map +1 -1
  163. package/esm/models/inviteusertoteamop.js +11 -0
  164. package/esm/models/inviteusertoteamop.js.map +1 -1
  165. package/esm/models/listaccessgroupmembersop.d.ts +3 -0
  166. package/esm/models/listaccessgroupmembersop.d.ts.map +1 -1
  167. package/esm/models/listaccessgroupmembersop.js +1 -0
  168. package/esm/models/listaccessgroupmembersop.js.map +1 -1
  169. package/esm/models/listaliasesop.d.ts +141 -39
  170. package/esm/models/listaliasesop.d.ts.map +1 -1
  171. package/esm/models/listaliasesop.js +132 -35
  172. package/esm/models/listaliasesop.js.map +1 -1
  173. package/esm/models/listdeploymentaliasesop.d.ts +30 -30
  174. package/esm/models/listdeploymentaliasesop.d.ts.map +1 -1
  175. package/esm/models/listdeploymentaliasesop.js +34 -34
  176. package/esm/models/listdeploymentaliasesop.js.map +1 -1
  177. package/esm/models/patchedgeconfigitemsop.d.ts +0 -4
  178. package/esm/models/patchedgeconfigitemsop.d.ts.map +1 -1
  179. package/esm/models/patchedgeconfigitemsop.js +0 -4
  180. package/esm/models/patchedgeconfigitemsop.js.map +1 -1
  181. package/esm/models/patchteamop.d.ts +185 -0
  182. package/esm/models/patchteamop.d.ts.map +1 -1
  183. package/esm/models/patchteamop.js +132 -0
  184. package/esm/models/patchteamop.js.map +1 -1
  185. package/esm/models/putfirewallconfigop.d.ts +3 -0
  186. package/esm/models/putfirewallconfigop.d.ts.map +1 -1
  187. package/esm/models/putfirewallconfigop.js +1 -0
  188. package/esm/models/putfirewallconfigop.js.map +1 -1
  189. package/esm/models/removecustomenvironmentop.d.ts +3 -3
  190. package/esm/models/removecustomenvironmentop.js +1 -1
  191. package/esm/models/removecustomenvironmentop.js.map +1 -1
  192. package/esm/models/removeprojectenvop.d.ts +9 -9
  193. package/esm/models/removeprojectenvop.js +3 -3
  194. package/esm/models/removeprojectenvop.js.map +1 -1
  195. package/esm/models/rerequestcheckop.d.ts +5 -0
  196. package/esm/models/rerequestcheckop.d.ts.map +1 -1
  197. package/esm/models/rerequestcheckop.js +2 -0
  198. package/esm/models/rerequestcheckop.js.map +1 -1
  199. package/esm/models/team.d.ts +142 -0
  200. package/esm/models/team.d.ts.map +1 -1
  201. package/esm/models/team.js +111 -0
  202. package/esm/models/team.js.map +1 -1
  203. package/esm/models/teamlimited.d.ts +15 -0
  204. package/esm/models/teamlimited.d.ts.map +1 -1
  205. package/esm/models/teamlimited.js +5 -0
  206. package/esm/models/teamlimited.js.map +1 -1
  207. package/esm/models/updatecustomenvironmentop.d.ts +3 -3
  208. package/esm/models/updatecustomenvironmentop.js +1 -1
  209. package/esm/models/updatecustomenvironmentop.js.map +1 -1
  210. package/esm/models/updateprojectdatacacheop.d.ts +226 -651
  211. package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
  212. package/esm/models/updateprojectdatacacheop.js +209 -604
  213. package/esm/models/updateprojectdatacacheop.js.map +1 -1
  214. package/esm/models/updateprojectop.d.ts +221 -643
  215. package/esm/models/updateprojectop.d.ts.map +1 -1
  216. package/esm/models/updateprojectop.js +198 -573
  217. package/esm/models/updateprojectop.js.map +1 -1
  218. package/esm/models/userevent.d.ts +1629 -1433
  219. package/esm/models/userevent.d.ts.map +1 -1
  220. package/esm/models/userevent.js +2023 -1841
  221. package/esm/models/userevent.js.map +1 -1
  222. package/esm/sdk/aliases.d.ts +2 -2
  223. package/esm/sdk/aliases.d.ts.map +1 -1
  224. package/examples/README.md +5 -0
  225. package/examples/package-lock.json +8 -7
  226. package/examples/projectsUpdateProject.example.ts +2 -0
  227. package/jsr.json +1 -1
  228. package/package.json +6 -8
  229. package/src/__tests__/aliases.test.ts +16 -16
  230. package/src/__tests__/security.test.ts +13 -1
  231. package/src/funcs/aliasesGetAlias.ts +5 -6
  232. package/src/funcs/checksRerequestCheck.ts +1 -0
  233. package/src/funcs/domainsBuyDomain.ts +2 -2
  234. package/src/funcs/domainsGetDomainConfig.ts +2 -2
  235. package/src/funcs/domainsPatchDomain.ts +2 -2
  236. package/src/funcs/edgeConfigPatchEdgeConfigItems.ts +2 -3
  237. package/src/funcs/marketplaceUpdateInstallationIntegrationEdgeConfig.ts +2 -2
  238. package/src/funcs/projectsAcceptProjectTransferRequest.ts +2 -2
  239. package/src/funcs/projectsCreateProject.ts +2 -2
  240. package/src/funcs/teamsPatchTeam.ts +2 -2
  241. package/src/lib/config.ts +3 -3
  242. package/src/mcp-server/mcp-server.ts +1 -1
  243. package/src/mcp-server/server.ts +1 -1
  244. package/src/models/acceptprojecttransferrequestop.ts +449 -4
  245. package/src/models/addbypassipop.ts +69 -78
  246. package/src/models/authtoken.ts +10 -8
  247. package/src/models/authuser.ts +93 -0
  248. package/src/models/canceldeploymentop.ts +734 -295
  249. package/src/models/createcustomenvironmentop.ts +1 -1
  250. package/src/models/createdeploymentop.ts +1122 -641
  251. package/src/models/createlogdrainop.ts +4 -4
  252. package/src/models/createprojectenvop.ts +2 -2
  253. package/src/models/createprojectop.ts +734 -1475
  254. package/src/models/createwebhookop.ts +4 -0
  255. package/src/models/editprojectenvop.ts +1 -1
  256. package/src/models/exchangessotokenop.ts +8 -8
  257. package/src/models/filterprojectenvsop.ts +3 -3
  258. package/src/models/getaliasop.ts +0 -1042
  259. package/src/models/getbypassipop.ts +100 -404
  260. package/src/models/getcustomenvironmentop.ts +1 -1
  261. package/src/models/getdeploymentop.ts +1761 -780
  262. package/src/models/getdeploymentsop.ts +1 -0
  263. package/src/models/getfirewallconfigop.ts +1 -0
  264. package/src/models/getintegrationlogdrainsop.ts +6 -4
  265. package/src/models/getprojectmembersop.ts +1 -0
  266. package/src/models/getprojectsop.ts +612 -1335
  267. package/src/models/getrecordsop.ts +16 -0
  268. package/src/models/getteammembersop.ts +2 -0
  269. package/src/models/getv9projectsidornamecustomenvironmentsop.ts +1 -1
  270. package/src/models/getwebhookop.ts +2 -0
  271. package/src/models/getwebhooksop.ts +5 -0
  272. package/src/models/inviteusertoteamop.ts +11 -0
  273. package/src/models/listaccessgroupmembersop.ts +1 -0
  274. package/src/models/listaliasesop.ts +290 -74
  275. package/src/models/listdeploymentaliasesop.ts +58 -70
  276. package/src/models/patchedgeconfigitemsop.ts +0 -8
  277. package/src/models/patchteamop.ts +311 -0
  278. package/src/models/putfirewallconfigop.ts +1 -0
  279. package/src/models/removecustomenvironmentop.ts +1 -1
  280. package/src/models/removeprojectenvop.ts +3 -3
  281. package/src/models/rerequestcheckop.ts +7 -0
  282. package/src/models/team.ts +240 -0
  283. package/src/models/teamlimited.ts +5 -0
  284. package/src/models/updatecustomenvironmentop.ts +1 -1
  285. package/src/models/updateprojectdatacacheop.ts +684 -1411
  286. package/src/models/updateprojectop.ts +601 -1343
  287. package/src/models/userevent.ts +3615 -3202
  288. package/src/sdk/aliases.ts +2 -2
  289. package/temp/example.ts +11 -0
  290. package/vercel-spec.json +2337 -2625
@@ -23,6 +23,7 @@ Allows to read an access group
23
23
 
24
24
  ### Example Usage
25
25
 
26
+ <!-- UsageSnippet language="typescript" operationID="readAccessGroup" method="get" path="/v1/access-groups/{idOrName}" -->
26
27
  ```typescript
27
28
  import { Vercel } from "@vercel/sdk";
28
29
 
@@ -101,6 +102,7 @@ Allows to update an access group metadata
101
102
 
102
103
  ### Example Usage
103
104
 
105
+ <!-- UsageSnippet language="typescript" operationID="updateAccessGroup" method="post" path="/v1/access-groups/{idOrName}" -->
104
106
  ```typescript
105
107
  import { Vercel } from "@vercel/sdk";
106
108
 
@@ -213,6 +215,7 @@ Allows to delete an access group
213
215
 
214
216
  ### Example Usage
215
217
 
218
+ <!-- UsageSnippet language="typescript" operationID="deleteAccessGroup" method="delete" path="/v1/access-groups/{idOrName}" -->
216
219
  ```typescript
217
220
  import { Vercel } from "@vercel/sdk";
218
221
 
@@ -291,6 +294,7 @@ List members of an access group
291
294
 
292
295
  ### Example Usage
293
296
 
297
+ <!-- UsageSnippet language="typescript" operationID="listAccessGroupMembers" method="get" path="/v1/access-groups/{idOrName}/members" -->
294
298
  ```typescript
295
299
  import { Vercel } from "@vercel/sdk";
296
300
 
@@ -371,6 +375,7 @@ List access groups
371
375
 
372
376
  ### Example Usage
373
377
 
378
+ <!-- UsageSnippet language="typescript" operationID="listAccessGroups" method="get" path="/v1/access-groups" -->
374
379
  ```typescript
375
380
  import { Vercel } from "@vercel/sdk";
376
381
 
@@ -457,6 +462,7 @@ Allows to create an access group
457
462
 
458
463
  ### Example Usage
459
464
 
465
+ <!-- UsageSnippet language="typescript" operationID="createAccessGroup" method="post" path="/v1/access-groups" -->
460
466
  ```typescript
461
467
  import { Vercel } from "@vercel/sdk";
462
468
 
@@ -575,6 +581,7 @@ List projects of an access group
575
581
 
576
582
  ### Example Usage
577
583
 
584
+ <!-- UsageSnippet language="typescript" operationID="listAccessGroupProjects" method="get" path="/v1/access-groups/{idOrName}/projects" -->
578
585
  ```typescript
579
586
  import { Vercel } from "@vercel/sdk";
580
587
 
@@ -655,6 +662,7 @@ Allows creation of an access group project
655
662
 
656
663
  ### Example Usage
657
664
 
665
+ <!-- UsageSnippet language="typescript" operationID="createAccessGroupProject" method="post" path="/v1/access-groups/{accessGroupIdOrName}/projects" -->
658
666
  ```typescript
659
667
  import { Vercel } from "@vercel/sdk";
660
668
 
@@ -741,6 +749,7 @@ Allows reading an access group project
741
749
 
742
750
  ### Example Usage
743
751
 
752
+ <!-- UsageSnippet language="typescript" operationID="readAccessGroupProject" method="get" path="/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}" -->
744
753
  ```typescript
745
754
  import { Vercel } from "@vercel/sdk";
746
755
 
@@ -821,6 +830,7 @@ Allows update of an access group project
821
830
 
822
831
  ### Example Usage
823
832
 
833
+ <!-- UsageSnippet language="typescript" operationID="updateAccessGroupProject" method="patch" path="/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}" -->
824
834
  ```typescript
825
835
  import { Vercel } from "@vercel/sdk";
826
836
 
@@ -907,6 +917,7 @@ Allows deletion of an access group project
907
917
 
908
918
  ### Example Usage
909
919
 
920
+ <!-- UsageSnippet language="typescript" operationID="deleteAccessGroupProject" method="delete" path="/v1/access-groups/{accessGroupIdOrName}/projects/{projectId}" -->
910
921
  ```typescript
911
922
  import { Vercel } from "@vercel/sdk";
912
923
 
@@ -18,6 +18,7 @@ Retrieves all Aliases for the Deployment with the given ID. The authenticated us
18
18
 
19
19
  ### Example Usage
20
20
 
21
+ <!-- UsageSnippet language="typescript" operationID="listDeploymentAliases" method="get" path="/v2/deployments/{id}/aliases" -->
21
22
  ```typescript
22
23
  import { Vercel } from "@vercel/sdk";
23
24
 
@@ -97,6 +98,7 @@ Creates a new alias for the deployment with the given deployment ID. The authent
97
98
 
98
99
  ### Example Usage
99
100
 
101
+ <!-- UsageSnippet language="typescript" operationID="assignAlias" method="post" path="/v2/deployments/{id}/aliases" -->
100
102
  ```typescript
101
103
  import { Vercel } from "@vercel/sdk";
102
104
 
@@ -184,6 +186,7 @@ Retrieves a list of aliases for the authenticated User or Team. When `domain` is
184
186
 
185
187
  ### Example Usage
186
188
 
189
+ <!-- UsageSnippet language="typescript" operationID="listAliases" method="get" path="/v4/aliases" -->
187
190
  ```typescript
188
191
  import { Vercel } from "@vercel/sdk";
189
192
 
@@ -275,6 +278,7 @@ Retrieves an Alias for the given host name or alias ID.
275
278
 
276
279
  ### Example Usage
277
280
 
281
+ <!-- UsageSnippet language="typescript" operationID="getAlias" method="get" path="/v4/aliases/{idOrAlias}" -->
278
282
  ```typescript
279
283
  import { Vercel } from "@vercel/sdk";
280
284
 
@@ -345,7 +349,7 @@ run();
345
349
 
346
350
  ### Response
347
351
 
348
- **Promise\<[models.GetAliasResponseBody](../../models/getaliasresponsebody.md)\>**
352
+ **Promise\<[any](../../models/.md)\>**
349
353
 
350
354
  ### Errors
351
355
 
@@ -362,6 +366,7 @@ Delete an Alias with the specified ID.
362
366
 
363
367
  ### Example Usage
364
368
 
369
+ <!-- UsageSnippet language="typescript" operationID="deleteAlias" method="delete" path="/v2/aliases/{aliasId}" -->
365
370
  ```typescript
366
371
  import { Vercel } from "@vercel/sdk";
367
372
 
@@ -441,6 +446,7 @@ Update the protection bypass for the alias or deployment URL (used for user acce
441
446
 
442
447
  ### Example Usage
443
448
 
449
+ <!-- UsageSnippet language="typescript" operationID="patchUrlProtectionBypass" method="patch" path="/aliases/{id}/protection-bypass" -->
444
450
  ```typescript
445
451
  import { Vercel } from "@vercel/sdk";
446
452
 
@@ -18,6 +18,7 @@ Records an artifacts cache usage event. The body of this request is an array of
18
18
 
19
19
  ### Example Usage
20
20
 
21
+ <!-- UsageSnippet language="typescript" operationID="recordEvents" method="post" path="/v8/artifacts/events" -->
21
22
  ```typescript
22
23
  import { Vercel } from "@vercel/sdk";
23
24
 
@@ -116,6 +117,7 @@ Check the status of Remote Caching for this principal. Returns a JSON-encoded st
116
117
 
117
118
  ### Example Usage
118
119
 
120
+ <!-- UsageSnippet language="typescript" operationID="status" method="get" path="/v8/artifacts/status" -->
119
121
  ```typescript
120
122
  import { Vercel } from "@vercel/sdk";
121
123
 
@@ -192,6 +194,7 @@ Uploads a cache artifact identified by the `hash` specified on the path. The cac
192
194
 
193
195
  ### Example Usage
194
196
 
197
+ <!-- UsageSnippet language="typescript" operationID="uploadArtifact" method="put" path="/v8/artifacts/{hash}" -->
195
198
  ```typescript
196
199
  import { Vercel } from "@vercel/sdk";
197
200
  import { openAsBlob } from "node:fs";
@@ -284,6 +287,7 @@ Downloads a cache artifact indentified by its `hash` specified on the request pa
284
287
 
285
288
  ### Example Usage
286
289
 
290
+ <!-- UsageSnippet language="typescript" operationID="downloadArtifact" method="get" path="/v8/artifacts/{hash}" -->
287
291
  ```typescript
288
292
  import { Vercel } from "@vercel/sdk";
289
293
 
@@ -367,6 +371,7 @@ Check that a cache artifact with the given `hash` exists. This request returns r
367
371
 
368
372
  ### Example Usage
369
373
 
374
+ <!-- UsageSnippet language="typescript" operationID="artifactExists" method="head" path="/v8/artifacts/{hash}" -->
370
375
  ```typescript
371
376
  import { Vercel } from "@vercel/sdk";
372
377
 
@@ -446,6 +451,7 @@ Query information about an array of artifacts.
446
451
 
447
452
  ### Example Usage
448
453
 
454
+ <!-- UsageSnippet language="typescript" operationID="artifactQuery" method="post" path="/v8/artifacts" -->
449
455
  ```typescript
450
456
  import { Vercel } from "@vercel/sdk";
451
457
 
@@ -17,6 +17,7 @@ During the autorization process, Vercel sends the user to the provider [redirect
17
17
 
18
18
  ### Example Usage
19
19
 
20
+ <!-- UsageSnippet language="typescript" operationID="exchange-sso-token" method="post" path="/v1/integrations/sso/token" -->
20
21
  ```typescript
21
22
  import { Vercel } from "@vercel/sdk";
22
23
 
@@ -91,6 +92,7 @@ Retrieve a list of the current User's authentication tokens.
91
92
 
92
93
  ### Example Usage
93
94
 
95
+ <!-- UsageSnippet language="typescript" operationID="listAuthTokens" method="get" path="/v5/user/tokens" -->
94
96
  ```typescript
95
97
  import { Vercel } from "@vercel/sdk";
96
98
 
@@ -160,6 +162,7 @@ Creates and returns a new authentication token for the currently authenticated U
160
162
 
161
163
  ### Example Usage
162
164
 
165
+ <!-- UsageSnippet language="typescript" operationID="createAuthToken" method="post" path="/v3/user/tokens" -->
163
166
  ```typescript
164
167
  import { Vercel } from "@vercel/sdk";
165
168
 
@@ -242,6 +245,7 @@ Retrieve metadata about an authentication token belonging to the currently authe
242
245
 
243
246
  ### Example Usage
244
247
 
248
+ <!-- UsageSnippet language="typescript" operationID="getAuthToken" method="get" path="/v5/user/tokens/{tokenId}" -->
245
249
  ```typescript
246
250
  import { Vercel } from "@vercel/sdk";
247
251
 
@@ -317,6 +321,7 @@ Invalidate an authentication token, such that it will no longer be valid for fut
317
321
 
318
322
  ### Example Usage
319
323
 
324
+ <!-- UsageSnippet language="typescript" operationID="deleteAuthToken" method="delete" path="/v3/user/tokens/{tokenId}" -->
320
325
  ```typescript
321
326
  import { Vercel } from "@vercel/sdk";
322
327
 
@@ -16,6 +16,7 @@ Get cert by id
16
16
 
17
17
  ### Example Usage
18
18
 
19
+ <!-- UsageSnippet language="typescript" operationID="getCertById" method="get" path="/v8/certs/{id}" -->
19
20
  ```typescript
20
21
  import { Vercel } from "@vercel/sdk";
21
22
 
@@ -95,6 +96,7 @@ Remove cert
95
96
 
96
97
  ### Example Usage
97
98
 
99
+ <!-- UsageSnippet language="typescript" operationID="removeCert" method="delete" path="/v8/certs/{id}" -->
98
100
  ```typescript
99
101
  import { Vercel } from "@vercel/sdk";
100
102
 
@@ -174,6 +176,7 @@ Issue a new cert
174
176
 
175
177
  ### Example Usage
176
178
 
179
+ <!-- UsageSnippet language="typescript" operationID="issueCert" method="post" path="/v8/certs" -->
177
180
  ```typescript
178
181
  import { Vercel } from "@vercel/sdk";
179
182
 
@@ -251,6 +254,7 @@ Upload a cert
251
254
 
252
255
  ### Example Usage
253
256
 
257
+ <!-- UsageSnippet language="typescript" operationID="uploadCert" method="put" path="/v8/certs" -->
254
258
  ```typescript
255
259
  import { Vercel } from "@vercel/sdk";
256
260
 
@@ -17,6 +17,7 @@ Creates a new check. This endpoint must be called with an OAuth2 or it will prod
17
17
 
18
18
  ### Example Usage
19
19
 
20
+ <!-- UsageSnippet language="typescript" operationID="createCheck" method="post" path="/v1/deployments/{deploymentId}/checks" -->
20
21
  ```typescript
21
22
  import { Vercel } from "@vercel/sdk";
22
23
 
@@ -112,6 +113,7 @@ List all of the checks created for a deployment.
112
113
 
113
114
  ### Example Usage
114
115
 
116
+ <!-- UsageSnippet language="typescript" operationID="getAllChecks" method="get" path="/v1/deployments/{deploymentId}/checks" -->
115
117
  ```typescript
116
118
  import { Vercel } from "@vercel/sdk";
117
119
 
@@ -191,6 +193,7 @@ Return a detailed response for a single check.
191
193
 
192
194
  ### Example Usage
193
195
 
196
+ <!-- UsageSnippet language="typescript" operationID="getCheck" method="get" path="/v1/deployments/{deploymentId}/checks/{checkId}" -->
194
197
  ```typescript
195
198
  import { Vercel } from "@vercel/sdk";
196
199
 
@@ -272,6 +275,7 @@ Update an existing check. This endpoint must be called with an OAuth2 or it will
272
275
 
273
276
  ### Example Usage
274
277
 
278
+ <!-- UsageSnippet language="typescript" operationID="updateCheck" method="patch" path="/v1/deployments/{deploymentId}/checks/{checkId}" -->
275
279
  ```typescript
276
280
  import { Vercel } from "@vercel/sdk";
277
281
 
@@ -423,6 +427,7 @@ Rerequest a selected check that has failed.
423
427
 
424
428
  ### Example Usage
425
429
 
430
+ <!-- UsageSnippet language="typescript" operationID="rerequestCheck" method="post" path="/v1/deployments/{deploymentId}/checks/{checkId}/rerequest" -->
426
431
  ```typescript
427
432
  import { Vercel } from "@vercel/sdk";
428
433
 
@@ -22,6 +22,7 @@ Get the build logs of a deployment by deployment ID and build ID. It can work as
22
22
 
23
23
  ### Example Usage
24
24
 
25
+ <!-- UsageSnippet language="typescript" operationID="getDeploymentEvents" method="get" path="/v3/deployments/{idOrUrl}/events" -->
25
26
  ```typescript
26
27
  import { Vercel } from "@vercel/sdk";
27
28
 
@@ -118,6 +119,7 @@ Updates the deployment integration action for the specified integration installa
118
119
 
119
120
  ### Example Usage
120
121
 
122
+ <!-- UsageSnippet language="typescript" operationID="update-integration-deployment-action" method="patch" path="/v1/deployments/{deploymentId}/integrations/{integrationConfigurationId}/resources/{resourceId}/actions/{action}" -->
121
123
  ```typescript
122
124
  import { Vercel } from "@vercel/sdk";
123
125
 
@@ -198,6 +200,7 @@ Retrieves information for a deployment either by supplying its ID (`id` property
198
200
 
199
201
  ### Example Usage
200
202
 
203
+ <!-- UsageSnippet language="typescript" operationID="getDeployment" method="get" path="/v13/deployments/{idOrUrl}" -->
201
204
  ```typescript
202
205
  import { Vercel } from "@vercel/sdk";
203
206
 
@@ -278,6 +281,7 @@ Create a new deployment with all the required and intended data. If the deployme
278
281
 
279
282
  ### Example Usage
280
283
 
284
+ <!-- UsageSnippet language="typescript" operationID="createDeployment" method="post" path="/v13/deployments" -->
281
285
  ```typescript
282
286
  import { Vercel } from "@vercel/sdk";
283
287
 
@@ -304,6 +308,10 @@ async function run() {
304
308
  commitRef: "main",
305
309
  commitSha: "dc36199b2234c6586ebe05ec94078a895c707e29",
306
310
  dirty: true,
311
+ ci: true,
312
+ ciType: "github-actions",
313
+ ciGitProviderUsername: "rauchg",
314
+ ciGitRepoVisibility: "private",
307
315
  },
308
316
  gitSource: {
309
317
  org: "vercel",
@@ -364,6 +372,10 @@ async function run() {
364
372
  commitRef: "main",
365
373
  commitSha: "dc36199b2234c6586ebe05ec94078a895c707e29",
366
374
  dirty: true,
375
+ ci: true,
376
+ ciType: "github-actions",
377
+ ciGitProviderUsername: "rauchg",
378
+ ciGitRepoVisibility: "private",
367
379
  },
368
380
  gitSource: {
369
381
  org: "vercel",
@@ -423,6 +435,7 @@ This endpoint allows you to cancel a deployment which is currently building, by
423
435
 
424
436
  ### Example Usage
425
437
 
438
+ <!-- UsageSnippet language="typescript" operationID="cancelDeployment" method="patch" path="/v12/deployments/{id}/cancel" -->
426
439
  ```typescript
427
440
  import { Vercel } from "@vercel/sdk";
428
441
 
@@ -502,6 +515,7 @@ Before you create a deployment you need to upload the required files for that de
502
515
 
503
516
  ### Example Usage
504
517
 
518
+ <!-- UsageSnippet language="typescript" operationID="uploadFile" method="post" path="/v2/files" -->
505
519
  ```typescript
506
520
  import { Vercel } from "@vercel/sdk";
507
521
 
@@ -578,6 +592,7 @@ Allows to retrieve the file structure of the source code of a deployment by supp
578
592
 
579
593
  ### Example Usage
580
594
 
595
+ <!-- UsageSnippet language="typescript" operationID="listDeploymentFiles" method="get" path="/v6/deployments/{id}/files" -->
581
596
  ```typescript
582
597
  import { Vercel } from "@vercel/sdk";
583
598
 
@@ -657,6 +672,7 @@ Allows to retrieve the content of a file by supplying the file identifier and th
657
672
 
658
673
  ### Example Usage
659
674
 
675
+ <!-- UsageSnippet language="typescript" operationID="getDeploymentFileContents" method="get" path="/v8/deployments/{id}/files/{fileId}" -->
660
676
  ```typescript
661
677
  import { Vercel } from "@vercel/sdk";
662
678
 
@@ -738,6 +754,7 @@ List deployments under the authenticated user or team. If a deployment hasn't fi
738
754
 
739
755
  ### Example Usage
740
756
 
757
+ <!-- UsageSnippet language="typescript" operationID="getDeployments" method="get" path="/v6/deployments" -->
741
758
  ```typescript
742
759
  import { Vercel } from "@vercel/sdk";
743
760
 
@@ -835,6 +852,7 @@ This API allows you to delete a deployment, either by supplying its `id` in the
835
852
 
836
853
  ### Example Usage
837
854
 
855
+ <!-- UsageSnippet language="typescript" operationID="deleteDeployment" method="delete" path="/v13/deployments/{id}" -->
838
856
  ```typescript
839
857
  import { Vercel } from "@vercel/sdk";
840
858
 
@@ -16,6 +16,7 @@ Retrieves a list of DNS records created for a domain name. By default it returns
16
16
 
17
17
  ### Example Usage
18
18
 
19
+ <!-- UsageSnippet language="typescript" operationID="getRecords" method="get" path="/v4/domains/{domain}/records" -->
19
20
  ```typescript
20
21
  import { Vercel } from "@vercel/sdk";
21
22
 
@@ -101,6 +102,7 @@ Creates a DNS record for a domain.
101
102
 
102
103
  ### Example Usage
103
104
 
105
+ <!-- UsageSnippet language="typescript" operationID="createRecord" method="post" path="/v2/domains/{domain}/records" -->
104
106
  ```typescript
105
107
  import { Vercel } from "@vercel/sdk";
106
108
 
@@ -202,6 +204,7 @@ Updates an existing DNS record for a domain name.
202
204
 
203
205
  ### Example Usage
204
206
 
207
+ <!-- UsageSnippet language="typescript" operationID="updateRecord" method="patch" path="/v1/domains/records/{recordId}" -->
205
208
  ```typescript
206
209
  import { Vercel } from "@vercel/sdk";
207
210
 
@@ -299,6 +302,7 @@ Removes an existing DNS record from a domain name.
299
302
 
300
303
  ### Example Usage
301
304
 
305
+ <!-- UsageSnippet language="typescript" operationID="removeRecord" method="delete" path="/v2/domains/{domain}/records/{recordId}" -->
302
306
  ```typescript
303
307
  import { Vercel } from "@vercel/sdk";
304
308
 
@@ -22,6 +22,7 @@ Allows to purchase the specified domain.
22
22
 
23
23
  ### Example Usage
24
24
 
25
+ <!-- UsageSnippet language="typescript" operationID="buyDomain" method="post" path="/v5/domains/buy" -->
25
26
  ```typescript
26
27
  import { Vercel } from "@vercel/sdk";
27
28
 
@@ -129,6 +130,7 @@ Check the price to purchase a domain and how long a single purchase period is.
129
130
 
130
131
  ### Example Usage
131
132
 
133
+ <!-- UsageSnippet language="typescript" operationID="checkDomainPrice" method="get" path="/v4/domains/price" -->
132
134
  ```typescript
133
135
  import { Vercel } from "@vercel/sdk";
134
136
 
@@ -209,6 +211,7 @@ Check if a domain name is available for purchase.
209
211
 
210
212
  ### Example Usage
211
213
 
214
+ <!-- UsageSnippet language="typescript" operationID="checkDomainStatus" method="get" path="/v4/domains/status" -->
212
215
  ```typescript
213
216
  import { Vercel } from "@vercel/sdk";
214
217
 
@@ -287,6 +290,7 @@ Fetch domain transfer availability or transfer status if a transfer is in progre
287
290
 
288
291
  ### Example Usage
289
292
 
293
+ <!-- UsageSnippet language="typescript" operationID="getDomainTransfer" method="get" path="/v1/domains/{domain}/registry" -->
290
294
  ```typescript
291
295
  import { Vercel } from "@vercel/sdk";
292
296
 
@@ -365,6 +369,7 @@ Get a Domain's configuration.
365
369
 
366
370
  ### Example Usage
367
371
 
372
+ <!-- UsageSnippet language="typescript" operationID="getDomainConfig" method="get" path="/v6/domains/{domain}/config" -->
368
373
  ```typescript
369
374
  import { Vercel } from "@vercel/sdk";
370
375
 
@@ -443,6 +448,7 @@ Get information for a single domain in an account or team.
443
448
 
444
449
  ### Example Usage
445
450
 
451
+ <!-- UsageSnippet language="typescript" operationID="getDomain" method="get" path="/v5/domains/{domain}" -->
446
452
  ```typescript
447
453
  import { Vercel } from "@vercel/sdk";
448
454
 
@@ -522,6 +528,7 @@ Retrieves a list of domains registered for the authenticated user or team. By de
522
528
 
523
529
  ### Example Usage
524
530
 
531
+ <!-- UsageSnippet language="typescript" operationID="getDomains" method="get" path="/v5/domains" -->
525
532
  ```typescript
526
533
  import { Vercel } from "@vercel/sdk";
527
534
 
@@ -604,6 +611,7 @@ This endpoint is used for adding a new apex domain name with Vercel for the auth
604
611
 
605
612
  ### Example Usage
606
613
 
614
+ <!-- UsageSnippet language="typescript" operationID="createOrTransferDomain" method="post" path="/v7/domains" -->
607
615
  ```typescript
608
616
  import { Vercel } from "@vercel/sdk";
609
617
 
@@ -691,6 +699,7 @@ Update or move apex domain.
691
699
 
692
700
  ### Example Usage
693
701
 
702
+ <!-- UsageSnippet language="typescript" operationID="patchDomain" method="patch" path="/v3/domains/{domain}" -->
694
703
  ```typescript
695
704
  import { Vercel } from "@vercel/sdk";
696
705
 
@@ -776,6 +785,7 @@ Delete a previously registered domain name from Vercel. Deleting a domain will a
776
785
 
777
786
  ### Example Usage
778
787
 
788
+ <!-- UsageSnippet language="typescript" operationID="deleteDomain" method="delete" path="/v6/domains/{domain}" -->
779
789
  ```typescript
780
790
  import { Vercel } from "@vercel/sdk";
781
791
 
@@ -29,6 +29,7 @@ Returns all Edge Configs.
29
29
 
30
30
  ### Example Usage
31
31
 
32
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigs" method="get" path="/v1/edge-config" -->
32
33
  ```typescript
33
34
  import { Vercel } from "@vercel/sdk";
34
35
 
@@ -105,6 +106,7 @@ Creates an Edge Config.
105
106
 
106
107
  ### Example Usage
107
108
 
109
+ <!-- UsageSnippet language="typescript" operationID="createEdgeConfig" method="post" path="/v1/edge-config" -->
108
110
  ```typescript
109
111
  import { Vercel } from "@vercel/sdk";
110
112
 
@@ -187,6 +189,7 @@ Returns an Edge Config.
187
189
 
188
190
  ### Example Usage
189
191
 
192
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfig" method="get" path="/v1/edge-config/{edgeConfigId}" -->
190
193
  ```typescript
191
194
  import { Vercel } from "@vercel/sdk";
192
195
 
@@ -266,6 +269,7 @@ Updates an Edge Config.
266
269
 
267
270
  ### Example Usage
268
271
 
272
+ <!-- UsageSnippet language="typescript" operationID="updateEdgeConfig" method="put" path="/v1/edge-config/{edgeConfigId}" -->
269
273
  ```typescript
270
274
  import { Vercel } from "@vercel/sdk";
271
275
 
@@ -351,6 +355,7 @@ Delete an Edge Config by id.
351
355
 
352
356
  ### Example Usage
353
357
 
358
+ <!-- UsageSnippet language="typescript" operationID="deleteEdgeConfig" method="delete" path="/v1/edge-config/{edgeConfigId}" -->
354
359
  ```typescript
355
360
  import { Vercel } from "@vercel/sdk";
356
361
 
@@ -430,6 +435,7 @@ Returns all items of an Edge Config.
430
435
 
431
436
  ### Example Usage
432
437
 
438
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigItems" method="get" path="/v1/edge-config/{edgeConfigId}/items" -->
433
439
  ```typescript
434
440
  import { Vercel } from "@vercel/sdk";
435
441
 
@@ -509,6 +515,7 @@ Update multiple Edge Config Items in batch.
509
515
 
510
516
  ### Example Usage
511
517
 
518
+ <!-- UsageSnippet language="typescript" operationID="patchEdgeConfigItems" method="patch" path="/v1/edge-config/{edgeConfigId}/items" -->
512
519
  ```typescript
513
520
  import { Vercel } from "@vercel/sdk";
514
521
 
@@ -588,6 +595,7 @@ Returns the schema of an Edge Config.
588
595
 
589
596
  ### Example Usage
590
597
 
598
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigSchema" method="get" path="/v1/edge-config/{edgeConfigId}/schema" -->
591
599
  ```typescript
592
600
  import { Vercel } from "@vercel/sdk";
593
601
 
@@ -667,6 +675,7 @@ Update an Edge Config's schema.
667
675
 
668
676
  ### Example Usage
669
677
 
678
+ <!-- UsageSnippet language="typescript" operationID="patchEdgeConfigSchema" method="post" path="/v1/edge-config/{edgeConfigId}/schema" -->
670
679
  ```typescript
671
680
  import { Vercel } from "@vercel/sdk";
672
681
 
@@ -752,6 +761,7 @@ Deletes the schema of existing Edge Config.
752
761
 
753
762
  ### Example Usage
754
763
 
764
+ <!-- UsageSnippet language="typescript" operationID="deleteEdgeConfigSchema" method="delete" path="/v1/edge-config/{edgeConfigId}/schema" -->
755
765
  ```typescript
756
766
  import { Vercel } from "@vercel/sdk";
757
767
 
@@ -831,6 +841,7 @@ Returns a specific Edge Config Item.
831
841
 
832
842
  ### Example Usage
833
843
 
844
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigItem" method="get" path="/v1/edge-config/{edgeConfigId}/item/{edgeConfigItemKey}" -->
834
845
  ```typescript
835
846
  import { Vercel } from "@vercel/sdk";
836
847
 
@@ -912,6 +923,7 @@ Returns all tokens of an Edge Config.
912
923
 
913
924
  ### Example Usage
914
925
 
926
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigTokens" method="get" path="/v1/edge-config/{edgeConfigId}/tokens" -->
915
927
  ```typescript
916
928
  import { Vercel } from "@vercel/sdk";
917
929
 
@@ -991,6 +1003,7 @@ Deletes one or more tokens of an existing Edge Config.
991
1003
 
992
1004
  ### Example Usage
993
1005
 
1006
+ <!-- UsageSnippet language="typescript" operationID="deleteEdgeConfigTokens" method="delete" path="/v1/edge-config/{edgeConfigId}/tokens" -->
994
1007
  ```typescript
995
1008
  import { Vercel } from "@vercel/sdk";
996
1009
 
@@ -1084,6 +1097,7 @@ Return meta data about an Edge Config token.
1084
1097
 
1085
1098
  ### Example Usage
1086
1099
 
1100
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigToken" method="get" path="/v1/edge-config/{edgeConfigId}/token/{token}" -->
1087
1101
  ```typescript
1088
1102
  import { Vercel } from "@vercel/sdk";
1089
1103
 
@@ -1165,6 +1179,7 @@ Adds a token to an existing Edge Config.
1165
1179
 
1166
1180
  ### Example Usage
1167
1181
 
1182
+ <!-- UsageSnippet language="typescript" operationID="createEdgeConfigToken" method="post" path="/v1/edge-config/{edgeConfigId}/token" -->
1168
1183
  ```typescript
1169
1184
  import { Vercel } from "@vercel/sdk";
1170
1185
 
@@ -1250,6 +1265,7 @@ Retrieves a specific version of an Edge Config from backup storage.
1250
1265
 
1251
1266
  ### Example Usage
1252
1267
 
1268
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigBackup" method="get" path="/v1/edge-config/{edgeConfigId}/backups/{edgeConfigBackupVersionId}" -->
1253
1269
  ```typescript
1254
1270
  import { Vercel } from "@vercel/sdk";
1255
1271
 
@@ -1331,6 +1347,7 @@ Returns backups of an Edge Config.
1331
1347
 
1332
1348
  ### Example Usage
1333
1349
 
1350
+ <!-- UsageSnippet language="typescript" operationID="getEdgeConfigBackups" method="get" path="/v1/edge-config/{edgeConfigId}/backups" -->
1334
1351
  ```typescript
1335
1352
  import { Vercel } from "@vercel/sdk";
1336
1353
 
@@ -17,6 +17,7 @@ Creates a custom environment for the current project. Cannot be named 'Productio
17
17
 
18
18
  ### Example Usage
19
19
 
20
+ <!-- UsageSnippet language="typescript" operationID="createCustomEnvironment" method="post" path="/v9/projects/{idOrName}/custom-environments" -->
20
21
  ```typescript
21
22
  import { Vercel } from "@vercel/sdk";
22
23
 
@@ -95,6 +96,7 @@ Retrieve custom environments for the project. Must not be named 'Production' or
95
96
 
96
97
  ### Example Usage
97
98
 
99
+ <!-- UsageSnippet language="typescript" operationID="get_/v9/projects/{idOrName}/custom-environments" method="get" path="/v9/projects/{idOrName}/custom-environments" -->
98
100
  ```typescript
99
101
  import { Vercel } from "@vercel/sdk";
100
102
 
@@ -173,6 +175,7 @@ Retrieve a custom environment for the project. Must not be named 'Production' or
173
175
 
174
176
  ### Example Usage
175
177
 
178
+ <!-- UsageSnippet language="typescript" operationID="getCustomEnvironment" method="get" path="/v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}" -->
176
179
  ```typescript
177
180
  import { Vercel } from "@vercel/sdk";
178
181
 
@@ -254,6 +257,7 @@ Update a custom environment for the project. Must not be named 'Production' or '
254
257
 
255
258
  ### Example Usage
256
259
 
260
+ <!-- UsageSnippet language="typescript" operationID="updateCustomEnvironment" method="patch" path="/v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}" -->
257
261
  ```typescript
258
262
  import { Vercel } from "@vercel/sdk";
259
263
 
@@ -334,6 +338,7 @@ Remove a custom environment for the project. Must not be named 'Production' or '
334
338
 
335
339
  ### Example Usage
336
340
 
341
+ <!-- UsageSnippet language="typescript" operationID="removeCustomEnvironment" method="delete" path="/v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}" -->
337
342
  ```typescript
338
343
  import { Vercel } from "@vercel/sdk";
339
344