@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
@@ -16,6 +16,7 @@ Updates the deployment integration action for the specified integration installa
16
16
 
17
17
  ### Example Usage
18
18
 
19
+ <!-- UsageSnippet language="typescript" operationID="update-integration-deployment-action" method="patch" path="/v1/deployments/{deploymentId}/integrations/{integrationConfigurationId}/resources/{resourceId}/actions/{action}" -->
19
20
  ```typescript
20
21
  import { Vercel } from "@vercel/sdk";
21
22
 
@@ -96,6 +97,7 @@ Allows to retrieve all configurations for an authenticated integration. When the
96
97
 
97
98
  ### Example Usage
98
99
 
100
+ <!-- UsageSnippet language="typescript" operationID="getConfigurations" method="get" path="/v1/integrations/configurations" -->
99
101
  ```typescript
100
102
  import { Vercel } from "@vercel/sdk";
101
103
 
@@ -174,6 +176,7 @@ Allows to retrieve a the configuration with the provided id in case it exists. T
174
176
 
175
177
  ### Example Usage
176
178
 
179
+ <!-- UsageSnippet language="typescript" operationID="getConfiguration" method="get" path="/v1/integrations/configuration/{id}" -->
177
180
  ```typescript
178
181
  import { Vercel } from "@vercel/sdk";
179
182
 
@@ -253,6 +256,7 @@ Allows to remove the configuration with the `id` provided in the parameters. The
253
256
 
254
257
  ### Example Usage
255
258
 
259
+ <!-- UsageSnippet language="typescript" operationID="deleteConfiguration" method="delete" path="/v1/integrations/configuration/{id}" -->
256
260
  ```typescript
257
261
  import { Vercel } from "@vercel/sdk";
258
262
 
@@ -15,6 +15,7 @@ Retrieves a list of all Integration log drains that are defined for the authenti
15
15
 
16
16
  ### Example Usage
17
17
 
18
+ <!-- UsageSnippet language="typescript" operationID="getIntegrationLogDrains" method="get" path="/v2/integrations/log-drains" -->
18
19
  ```typescript
19
20
  import { Vercel } from "@vercel/sdk";
20
21
 
@@ -91,6 +92,7 @@ Creates an Integration log drain. This endpoint must be called with an OAuth2 cl
91
92
 
92
93
  ### Example Usage
93
94
 
95
+ <!-- UsageSnippet language="typescript" operationID="createLogDrain" method="post" path="/v2/integrations/log-drains" -->
94
96
  ```typescript
95
97
  import { Vercel } from "@vercel/sdk";
96
98
 
@@ -179,6 +181,7 @@ Deletes the Integration log drain with the provided `id`. When using an OAuth2 T
179
181
 
180
182
  ### Example Usage
181
183
 
184
+ <!-- UsageSnippet language="typescript" operationID="deleteIntegrationLogDrain" method="delete" path="/v1/integrations/log-drains/{id}" -->
182
185
  ```typescript
183
186
  import { Vercel } from "@vercel/sdk";
184
187
 
@@ -13,6 +13,7 @@ Returns a stream of logs for a given deployment.
13
13
 
14
14
  ### Example Usage
15
15
 
16
+ <!-- UsageSnippet language="typescript" operationID="getRuntimeLogs" method="get" path="/v1/projects/{projectId}/deployments/{deploymentId}/runtime-logs" -->
16
17
  ```typescript
17
18
  import { Vercel } from "@vercel/sdk";
18
19
 
@@ -32,6 +32,7 @@ Fetches the best account or user’s contact info
32
32
 
33
33
  ### Example Usage
34
34
 
35
+ <!-- UsageSnippet language="typescript" operationID="get-account-info" method="get" path="/v1/installations/{integrationConfigurationId}/account" -->
35
36
  ```typescript
36
37
  import { Vercel } from "@vercel/sdk";
37
38
 
@@ -107,6 +108,7 @@ Returns the member role and other information for a given member ID ("user_id" c
107
108
 
108
109
  ### Example Usage
109
110
 
111
+ <!-- UsageSnippet language="typescript" operationID="get-member" method="get" path="/v1/installations/{integrationConfigurationId}/member/{memberId}" -->
110
112
  ```typescript
111
113
  import { Vercel } from "@vercel/sdk";
112
114
 
@@ -184,6 +186,7 @@ Partner notifies Vercel of any changes made to an Installation or a Resource. Ve
184
186
 
185
187
  ### Example Usage
186
188
 
189
+ <!-- UsageSnippet language="typescript" operationID="create-event" method="post" path="/v1/installations/{integrationConfigurationId}/events" -->
187
190
  ```typescript
188
191
  import { Vercel } from "@vercel/sdk";
189
192
 
@@ -269,6 +272,7 @@ Get all resources for a given installation ID.
269
272
 
270
273
  ### Example Usage
271
274
 
275
+ <!-- UsageSnippet language="typescript" operationID="get-integration-resources" method="get" path="/v1/installations/{integrationConfigurationId}/resources" -->
272
276
  ```typescript
273
277
  import { Vercel } from "@vercel/sdk";
274
278
 
@@ -344,6 +348,7 @@ Get a resource by its partner ID.
344
348
 
345
349
  ### Example Usage
346
350
 
351
+ <!-- UsageSnippet language="typescript" operationID="get-integration-resource" method="get" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}" -->
347
352
  ```typescript
348
353
  import { Vercel } from "@vercel/sdk";
349
354
 
@@ -421,6 +426,7 @@ Delete a resource owned by the selected installation ID.
421
426
 
422
427
  ### Example Usage
423
428
 
429
+ <!-- UsageSnippet language="typescript" operationID="delete-integration-resource" method="delete" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}" -->
424
430
  ```typescript
425
431
  import { Vercel } from "@vercel/sdk";
426
432
 
@@ -498,6 +504,7 @@ This endpoint imports (upserts) a resource to Vercel's installation. This may be
498
504
 
499
505
  ### Example Usage
500
506
 
507
+ <!-- UsageSnippet language="typescript" operationID="import-resource" method="put" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}" -->
501
508
  ```typescript
502
509
  import { Vercel } from "@vercel/sdk";
503
510
 
@@ -575,6 +582,7 @@ Sends the billing and usage data. The partner should do this at least once a day
575
582
 
576
583
  ### Example Usage
577
584
 
585
+ <!-- UsageSnippet language="typescript" operationID="submit-billing-data" method="post" path="/v1/installations/{integrationConfigurationId}/billing" -->
578
586
  ```typescript
579
587
  import { Vercel } from "@vercel/sdk";
580
588
 
@@ -748,6 +756,7 @@ This endpoint allows the partner to submit an invoice to Vercel. The invoice is
748
756
 
749
757
  ### Example Usage
750
758
 
759
+ <!-- UsageSnippet language="typescript" operationID="submit-invoice" method="post" path="/v1/installations/{integrationConfigurationId}/billing/invoices" -->
751
760
  ```typescript
752
761
  import { Vercel } from "@vercel/sdk";
753
762
 
@@ -873,6 +882,7 @@ Get Invoice details and status for a given invoice ID.<br/> <br/> See Billing Ev
873
882
 
874
883
  ### Example Usage
875
884
 
885
+ <!-- UsageSnippet language="typescript" operationID="get-invoice" method="get" path="/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}" -->
876
886
  ```typescript
877
887
  import { Vercel } from "@vercel/sdk";
878
888
 
@@ -950,6 +960,7 @@ This endpoint allows the partner to request a refund for an invoice to Vercel. T
950
960
 
951
961
  ### Example Usage
952
962
 
963
+ <!-- UsageSnippet language="typescript" operationID="update-invoice" method="post" path="/v1/installations/{integrationConfigurationId}/billing/invoices/{invoiceId}/actions" -->
953
964
  ```typescript
954
965
  import { Vercel } from "@vercel/sdk";
955
966
 
@@ -1037,6 +1048,7 @@ Sends the prepayment balances. The partner should do this at least once a day an
1037
1048
 
1038
1049
  ### Example Usage
1039
1050
 
1051
+ <!-- UsageSnippet language="typescript" operationID="submit-prepayment-balances" method="post" path="/v1/installations/{integrationConfigurationId}/billing/balance" -->
1040
1052
  ```typescript
1041
1053
  import { Vercel } from "@vercel/sdk";
1042
1054
 
@@ -1112,6 +1124,7 @@ This endpoint is deprecated and replaced with the endpoint [Update Resource Secr
1112
1124
 
1113
1125
  ### Example Usage
1114
1126
 
1127
+ <!-- UsageSnippet language="typescript" operationID="update-resource-secrets" method="put" path="/v1/installations/{integrationConfigurationId}/products/{integrationProductIdOrSlug}/resources/{resourceId}/secrets" -->
1115
1128
  ```typescript
1116
1129
  import { Vercel } from "@vercel/sdk";
1117
1130
 
@@ -1197,6 +1210,7 @@ This endpoint updates the secrets of a resource. If a resource has projects conn
1197
1210
 
1198
1211
  ### Example Usage
1199
1212
 
1213
+ <!-- UsageSnippet language="typescript" operationID="update-resource-secrets-by-id" method="put" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}/secrets" -->
1200
1214
  ```typescript
1201
1215
  import { Vercel } from "@vercel/sdk";
1202
1216
 
@@ -1274,6 +1288,7 @@ During the autorization process, Vercel sends the user to the provider [redirect
1274
1288
 
1275
1289
  ### Example Usage
1276
1290
 
1291
+ <!-- UsageSnippet language="typescript" operationID="exchange-sso-token" method="post" path="/v1/integrations/sso/token" -->
1277
1292
  ```typescript
1278
1293
  import { Vercel } from "@vercel/sdk";
1279
1294
 
@@ -1348,6 +1363,7 @@ Create one or multiple experimentation items
1348
1363
 
1349
1364
  ### Example Usage
1350
1365
 
1366
+ <!-- UsageSnippet language="typescript" operationID="post_/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items" method="post" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items" -->
1351
1367
  ```typescript
1352
1368
  import { Vercel } from "@vercel/sdk";
1353
1369
 
@@ -1425,6 +1441,7 @@ Patch an existing experimentation item
1425
1441
 
1426
1442
  ### Example Usage
1427
1443
 
1444
+ <!-- UsageSnippet language="typescript" operationID="patch_/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}" method="patch" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}" -->
1428
1445
  ```typescript
1429
1446
  import { Vercel } from "@vercel/sdk";
1430
1447
 
@@ -1504,6 +1521,7 @@ Delete an existing experimentation item
1504
1521
 
1505
1522
  ### Example Usage
1506
1523
 
1524
+ <!-- UsageSnippet language="typescript" operationID="delete_/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}" method="delete" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/items/{itemId}" -->
1507
1525
  ```typescript
1508
1526
  import { Vercel } from "@vercel/sdk";
1509
1527
 
@@ -1583,6 +1601,7 @@ When the user enabled Edge Config syncing, then this endpoint can be used by the
1583
1601
 
1584
1602
  ### Example Usage
1585
1603
 
1604
+ <!-- UsageSnippet language="typescript" operationID="head_/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/edge-config" method="head" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/edge-config" -->
1586
1605
  ```typescript
1587
1606
  import { Vercel } from "@vercel/sdk";
1588
1607
 
@@ -1660,6 +1679,7 @@ When the user enabled Edge Config syncing, then this endpoint can be used by the
1660
1679
 
1661
1680
  ### Example Usage
1662
1681
 
1682
+ <!-- UsageSnippet language="typescript" operationID="put_/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/edge-config" method="put" path="/v1/installations/{integrationConfigurationId}/resources/{resourceId}/experimentation/edge-config" -->
1663
1683
  ```typescript
1664
1684
  import { Vercel } from "@vercel/sdk";
1665
1685
 
@@ -15,6 +15,7 @@ Lists all members of a project.
15
15
 
16
16
  ### Example Usage
17
17
 
18
+ <!-- UsageSnippet language="typescript" operationID="getProjectMembers" method="get" path="/v1/projects/{idOrName}/members" -->
18
19
  ```typescript
19
20
  import { Vercel } from "@vercel/sdk";
20
21
 
@@ -99,6 +100,7 @@ Adds a new member to the project.
99
100
 
100
101
  ### Example Usage
101
102
 
103
+ <!-- UsageSnippet language="typescript" operationID="addProjectMember" method="post" path="/v1/projects/{idOrName}/members" -->
102
104
  ```typescript
103
105
  import { Vercel } from "@vercel/sdk";
104
106
 
@@ -189,6 +191,7 @@ Remove a member from a specific project
189
191
 
190
192
  ### Example Usage
191
193
 
194
+ <!-- UsageSnippet language="typescript" operationID="removeProjectMember" method="delete" path="/v1/projects/{idOrName}/members/{uid}" -->
192
195
  ```typescript
193
196
  import { Vercel } from "@vercel/sdk";
194
197
 
@@ -36,6 +36,7 @@ Update the data cache feature on a project.
36
36
 
37
37
  ### Example Usage
38
38
 
39
+ <!-- UsageSnippet language="typescript" operationID="updateProjectDataCache" method="patch" path="/v1/data-cache/projects/{projectId}" -->
39
40
  ```typescript
40
41
  import { Vercel } from "@vercel/sdk";
41
42
 
@@ -121,6 +122,7 @@ Allows to retrieve the list of projects of the authenticated user or team. The l
121
122
 
122
123
  ### Example Usage
123
124
 
125
+ <!-- UsageSnippet language="typescript" operationID="getProjects" method="get" path="/v10/projects" -->
124
126
  ```typescript
125
127
  import { Vercel } from "@vercel/sdk";
126
128
 
@@ -201,6 +203,7 @@ Allows to create a new project with the provided configuration. It only requires
201
203
 
202
204
  ### Example Usage
203
205
 
206
+ <!-- UsageSnippet language="typescript" operationID="createProject" method="post" path="/v11/projects" -->
204
207
  ```typescript
205
208
  import { Vercel } from "@vercel/sdk";
206
209
 
@@ -283,6 +286,7 @@ Update the fields of a project using either its `name` or `id`.
283
286
 
284
287
  ### Example Usage
285
288
 
289
+ <!-- UsageSnippet language="typescript" operationID="updateProject" method="patch" path="/v9/projects/{idOrName}" -->
286
290
  ```typescript
287
291
  import { Vercel } from "@vercel/sdk";
288
292
 
@@ -368,6 +372,7 @@ Delete a specific project by passing either the project `id` or `name` in the UR
368
372
 
369
373
  ### Example Usage
370
374
 
375
+ <!-- UsageSnippet language="typescript" operationID="deleteProject" method="delete" path="/v9/projects/{idOrName}" -->
371
376
  ```typescript
372
377
  import { Vercel } from "@vercel/sdk";
373
378
 
@@ -446,6 +451,7 @@ Retrieve the domains associated with a given project by passing either the proje
446
451
 
447
452
  ### Example Usage
448
453
 
454
+ <!-- UsageSnippet language="typescript" operationID="getProjectDomains" method="get" path="/v9/projects/{idOrName}/domains" -->
449
455
  ```typescript
450
456
  import { Vercel } from "@vercel/sdk";
451
457
 
@@ -534,6 +540,7 @@ Get project domain by project id/name and domain name.
534
540
 
535
541
  ### Example Usage
536
542
 
543
+ <!-- UsageSnippet language="typescript" operationID="getProjectDomain" method="get" path="/v9/projects/{idOrName}/domains/{domain}" -->
537
544
  ```typescript
538
545
  import { Vercel } from "@vercel/sdk";
539
546
 
@@ -614,6 +621,7 @@ Update a project domain's configuration, including the name, git branch and redi
614
621
 
615
622
  ### Example Usage
616
623
 
624
+ <!-- UsageSnippet language="typescript" operationID="updateProjectDomain" method="patch" path="/v9/projects/{idOrName}/domains/{domain}" -->
617
625
  ```typescript
618
626
  import { Vercel } from "@vercel/sdk";
619
627
 
@@ -704,6 +712,7 @@ Remove a domain from a project by passing the domain name and by specifying the
704
712
 
705
713
  ### Example Usage
706
714
 
715
+ <!-- UsageSnippet language="typescript" operationID="removeProjectDomain" method="delete" path="/v9/projects/{idOrName}/domains/{domain}" -->
707
716
  ```typescript
708
717
  import { Vercel } from "@vercel/sdk";
709
718
 
@@ -785,6 +794,7 @@ Add a domain to the project by passing its domain name and by specifying the pro
785
794
 
786
795
  ### Example Usage
787
796
 
797
+ <!-- UsageSnippet language="typescript" operationID="addProjectDomain" method="post" path="/v10/projects/{idOrName}/domains" -->
788
798
  ```typescript
789
799
  import { Vercel } from "@vercel/sdk";
790
800
 
@@ -875,6 +885,7 @@ Move one project's domain to another project. Also allows the move of all redire
875
885
 
876
886
  ### Example Usage
877
887
 
888
+ <!-- UsageSnippet language="typescript" operationID="moveProjectDomain" method="post" path="/v1/projects/{idOrName}/domains/{domain}/move" -->
878
889
  ```typescript
879
890
  import { Vercel } from "@vercel/sdk";
880
891
 
@@ -955,6 +966,7 @@ Attempts to verify a project domain with `verified = false` by checking the corr
955
966
 
956
967
  ### Example Usage
957
968
 
969
+ <!-- UsageSnippet language="typescript" operationID="verifyProjectDomain" method="post" path="/v9/projects/{idOrName}/domains/{domain}/verify" -->
958
970
  ```typescript
959
971
  import { Vercel } from "@vercel/sdk";
960
972
 
@@ -1035,6 +1047,7 @@ Retrieve the environment variables for a given project by passing either the pro
1035
1047
 
1036
1048
  ### Example Usage
1037
1049
 
1050
+ <!-- UsageSnippet language="typescript" operationID="filterProjectEnvs" method="get" path="/v10/projects/{idOrName}/env" -->
1038
1051
  ```typescript
1039
1052
  import { Vercel } from "@vercel/sdk";
1040
1053
 
@@ -1123,6 +1136,7 @@ Create one or more environment variables for a project by passing its `key`, `va
1123
1136
 
1124
1137
  ### Example Usage
1125
1138
 
1139
+ <!-- UsageSnippet language="typescript" operationID="createProjectEnv" method="post" path="/v10/projects/{idOrName}/env" -->
1126
1140
  ```typescript
1127
1141
  import { Vercel } from "@vercel/sdk";
1128
1142
 
@@ -1229,6 +1243,7 @@ Retrieve the environment variable for a given project.
1229
1243
 
1230
1244
  ### Example Usage
1231
1245
 
1246
+ <!-- UsageSnippet language="typescript" operationID="getProjectEnv" method="get" path="/v1/projects/{idOrName}/env/{id}" -->
1232
1247
  ```typescript
1233
1248
  import { Vercel } from "@vercel/sdk";
1234
1249
 
@@ -1309,6 +1324,7 @@ Delete a specific environment variable for a given project by passing the enviro
1309
1324
 
1310
1325
  ### Example Usage
1311
1326
 
1327
+ <!-- UsageSnippet language="typescript" operationID="removeProjectEnv" method="delete" path="/v9/projects/{idOrName}/env/{id}" -->
1312
1328
  ```typescript
1313
1329
  import { Vercel } from "@vercel/sdk";
1314
1330
 
@@ -1392,6 +1408,7 @@ Edit a specific environment variable for a given project by passing the environm
1392
1408
 
1393
1409
  ### Example Usage
1394
1410
 
1411
+ <!-- UsageSnippet language="typescript" operationID="editProjectEnv" method="patch" path="/v9/projects/{idOrName}/env/{id}" -->
1395
1412
  ```typescript
1396
1413
  import { Vercel } from "@vercel/sdk";
1397
1414
 
@@ -1498,6 +1515,7 @@ Initiates a project transfer request from one team to another. <br/> Returns a `
1498
1515
 
1499
1516
  ### Example Usage
1500
1517
 
1518
+ <!-- UsageSnippet language="typescript" operationID="createProjectTransferRequest" method="post" path="/projects/{idOrName}/transfer-request" -->
1501
1519
  ```typescript
1502
1520
  import { Vercel } from "@vercel/sdk";
1503
1521
 
@@ -1576,6 +1594,7 @@ Accept a project transfer request initated by another team. <br/> The `code` is
1576
1594
 
1577
1595
  ### Example Usage
1578
1596
 
1597
+ <!-- UsageSnippet language="typescript" operationID="acceptProjectTransferRequest" method="put" path="/projects/transfer-request/{code}" -->
1579
1598
  ```typescript
1580
1599
  import { Vercel } from "@vercel/sdk";
1581
1600
 
@@ -1661,6 +1680,7 @@ Update the deployment protection automation bypass for a project
1661
1680
 
1662
1681
  ### Example Usage
1663
1682
 
1683
+ <!-- UsageSnippet language="typescript" operationID="updateProjectProtectionBypass" method="patch" path="/v1/projects/{idOrName}/protection-bypass" -->
1664
1684
  ```typescript
1665
1685
  import { Vercel } from "@vercel/sdk";
1666
1686
 
@@ -1742,6 +1762,7 @@ Allows users to promote a deployment to production. Note: This does NOT rebuild
1742
1762
 
1743
1763
  ### Example Usage
1744
1764
 
1765
+ <!-- UsageSnippet language="typescript" operationID="requestPromote" method="post" path="/v10/projects/{projectId}/promote/{deploymentId}" -->
1745
1766
  ```typescript
1746
1767
  import { Vercel } from "@vercel/sdk";
1747
1768
 
@@ -1822,6 +1843,7 @@ Get a list of aliases related to the last promote request with their mapping sta
1822
1843
 
1823
1844
  ### Example Usage
1824
1845
 
1846
+ <!-- UsageSnippet language="typescript" operationID="listPromoteAliases" method="get" path="/v1/projects/{projectId}/promote/aliases" -->
1825
1847
  ```typescript
1826
1848
  import { Vercel } from "@vercel/sdk";
1827
1849
 
@@ -1907,6 +1929,7 @@ Pause a project by passing its project `id` in the URL. If the project does not
1907
1929
 
1908
1930
  ### Example Usage
1909
1931
 
1932
+ <!-- UsageSnippet language="typescript" operationID="pauseProject" method="post" path="/v1/projects/{projectId}/pause" -->
1910
1933
  ```typescript
1911
1934
  import { Vercel } from "@vercel/sdk";
1912
1935
 
@@ -1985,6 +2008,7 @@ Unpause a project by passing its project `id` in the URL. If the project does no
1985
2008
 
1986
2009
  ### Example Usage
1987
2010
 
2011
+ <!-- UsageSnippet language="typescript" operationID="unpauseProject" method="post" path="/v1/projects/{projectId}/unpause" -->
1988
2012
  ```typescript
1989
2013
  import { Vercel } from "@vercel/sdk";
1990
2014
 
@@ -19,6 +19,7 @@ Get the Rolling Releases billing status for a project. The team level billing st
19
19
 
20
20
  ### Example Usage
21
21
 
22
+ <!-- UsageSnippet language="typescript" operationID="getRollingReleaseBillingStatus" method="get" path="/v1/projects/{idOrName}/rolling-release/billing" -->
22
23
  ```typescript
23
24
  import { Vercel } from "@vercel/sdk";
24
25
 
@@ -98,6 +99,7 @@ Get the Rolling Releases configuration for a project. The project-level config i
98
99
 
99
100
  ### Example Usage
100
101
 
102
+ <!-- UsageSnippet language="typescript" operationID="getRollingReleaseConfig" method="get" path="/v1/projects/{idOrName}/rolling-release/config" -->
101
103
  ```typescript
102
104
  import { Vercel } from "@vercel/sdk";
103
105
 
@@ -177,6 +179,7 @@ Disable Rolling Releases for a project means that future deployments will not un
177
179
 
178
180
  ### Example Usage
179
181
 
182
+ <!-- UsageSnippet language="typescript" operationID="deleteRollingReleaseConfig" method="delete" path="/v1/projects/{idOrName}/rolling-release/config" -->
180
183
  ```typescript
181
184
  import { Vercel } from "@vercel/sdk";
182
185
 
@@ -256,6 +259,7 @@ Update (or disable) Rolling Releases for a project. Changing the config never al
256
259
 
257
260
  ### Example Usage
258
261
 
262
+ <!-- UsageSnippet language="typescript" operationID="updateRollingReleaseConfig" method="patch" path="/v1/projects/{idOrName}/rolling-release/config" -->
259
263
  ```typescript
260
264
  import { Vercel } from "@vercel/sdk";
261
265
 
@@ -335,6 +339,7 @@ Return the Rolling Release for a project, regardless of whether the rollout is a
335
339
 
336
340
  ### Example Usage
337
341
 
342
+ <!-- UsageSnippet language="typescript" operationID="getRollingRelease" method="get" path="/v1/projects/{idOrName}/rolling-release" -->
338
343
  ```typescript
339
344
  import { Vercel } from "@vercel/sdk";
340
345
 
@@ -414,6 +419,7 @@ Advance a rollout to the next stage. This is only needed when rolling releases i
414
419
 
415
420
  ### Example Usage
416
421
 
422
+ <!-- UsageSnippet language="typescript" operationID="approveRollingReleaseStage" method="post" path="/v1/projects/{idOrName}/rolling-release/approve-stage" -->
417
423
  ```typescript
418
424
  import { Vercel } from "@vercel/sdk";
419
425
 
@@ -493,6 +499,7 @@ Force-complete a Rolling Release. The canary deployment will begin serving 100%
493
499
 
494
500
  ### Example Usage
495
501
 
502
+ <!-- UsageSnippet language="typescript" operationID="completeRollingRelease" method="post" path="/v1/projects/{idOrName}/rolling-release/complete" -->
496
503
  ```typescript
497
504
  import { Vercel } from "@vercel/sdk";
498
505
 
@@ -20,6 +20,7 @@ Update the setting for determining if the project has Attack Challenge mode enab
20
20
 
21
21
  ### Example Usage
22
22
 
23
+ <!-- UsageSnippet language="typescript" operationID="updateAttackChallengeMode" method="post" path="/v1/security/attack-mode" -->
23
24
  ```typescript
24
25
  import { Vercel } from "@vercel/sdk";
25
26
 
@@ -105,6 +106,7 @@ Set the firewall configuration to provided rules and settings. Creates or overwr
105
106
 
106
107
  ### Example Usage
107
108
 
109
+ <!-- UsageSnippet language="typescript" operationID="putFirewallConfig" method="put" path="/v1/security/firewall/config" -->
108
110
  ```typescript
109
111
  import { Vercel } from "@vercel/sdk";
110
112
 
@@ -190,6 +192,7 @@ Process updates to modify the existing firewall config for a project
190
192
 
191
193
  ### Example Usage
192
194
 
195
+ <!-- UsageSnippet language="typescript" operationID="updateFirewallConfig" method="patch" path="/v1/security/firewall/config" -->
193
196
  ```typescript
194
197
  import { Vercel } from "@vercel/sdk";
195
198
 
@@ -277,6 +280,7 @@ Retrieve the specified firewall configuration for a project. The deployed config
277
280
 
278
281
  ### Example Usage
279
282
 
283
+ <!-- UsageSnippet language="typescript" operationID="getFirewallConfig" method="get" path="/v1/security/firewall/config/{configVersion}" -->
280
284
  ```typescript
281
285
  import { Vercel } from "@vercel/sdk";
282
286
 
@@ -358,6 +362,7 @@ Retrieve active attack data within the last 24h window
358
362
 
359
363
  ### Example Usage
360
364
 
365
+ <!-- UsageSnippet language="typescript" operationID="getActiveAttackStatus" method="get" path="/v1/security/firewall/attack-status" -->
361
366
  ```typescript
362
367
  import { Vercel } from "@vercel/sdk";
363
368
 
@@ -437,6 +442,7 @@ Retrieve the system bypass rules configured for the specified project
437
442
 
438
443
  ### Example Usage
439
444
 
445
+ <!-- UsageSnippet language="typescript" operationID="getBypassIp" method="get" path="/v1/security/firewall/bypass" -->
440
446
  ```typescript
441
447
  import { Vercel } from "@vercel/sdk";
442
448
 
@@ -518,6 +524,7 @@ Create new system bypass rules
518
524
 
519
525
  ### Example Usage
520
526
 
527
+ <!-- UsageSnippet language="typescript" operationID="addBypassIp" method="post" path="/v1/security/firewall/bypass" -->
521
528
  ```typescript
522
529
  import { Vercel } from "@vercel/sdk";
523
530
 
@@ -597,6 +604,7 @@ Remove system bypass rules
597
604
 
598
605
  ### Example Usage
599
606
 
607
+ <!-- UsageSnippet language="typescript" operationID="removeBypassIp" method="delete" path="/v1/security/firewall/bypass" -->
600
608
  ```typescript
601
609
  import { Vercel } from "@vercel/sdk";
602
610
 
@@ -25,6 +25,7 @@ Get a paginated list of team members for the provided team.
25
25
 
26
26
  ### Example Usage
27
27
 
28
+ <!-- UsageSnippet language="typescript" operationID="getTeamMembers" method="get" path="/v3/teams/{teamId}/members" -->
28
29
  ```typescript
29
30
  import { Vercel } from "@vercel/sdk";
30
31
 
@@ -106,6 +107,7 @@ Invite a user to join the team specified in the URL. The authenticated user need
106
107
 
107
108
  ### Example Usage
108
109
 
110
+ <!-- UsageSnippet language="typescript" operationID="inviteUserToTeam" method="post" path="/v1/teams/{teamId}/members" -->
109
111
  ```typescript
110
112
  import { Vercel } from "@vercel/sdk";
111
113
 
@@ -210,6 +212,7 @@ Request access to a team as a member. An owner has to approve the request. Only
210
212
 
211
213
  ### Example Usage
212
214
 
215
+ <!-- UsageSnippet language="typescript" operationID="requestAccessToTeam" method="post" path="/v1/teams/{teamId}/request" -->
213
216
  ```typescript
214
217
  import { Vercel } from "@vercel/sdk";
215
218
 
@@ -305,6 +308,7 @@ Check the status of a join request. It'll respond with a 404 if the request has
305
308
 
306
309
  ### Example Usage
307
310
 
311
+ <!-- UsageSnippet language="typescript" operationID="getTeamAccessRequest" method="get" path="/v1/teams/{teamId}/request/{userId}" -->
308
312
  ```typescript
309
313
  import { Vercel } from "@vercel/sdk";
310
314
 
@@ -382,6 +386,7 @@ Join a team with a provided invite code or team ID.
382
386
 
383
387
  ### Example Usage
384
388
 
389
+ <!-- UsageSnippet language="typescript" operationID="joinTeam" method="post" path="/v1/teams/{teamId}/members/teams/join" -->
385
390
  ```typescript
386
391
  import { Vercel } from "@vercel/sdk";
387
392
 
@@ -463,6 +468,7 @@ Update the membership of a Team Member on the Team specified by `teamId`, such a
463
468
 
464
469
  ### Example Usage
465
470
 
471
+ <!-- UsageSnippet language="typescript" operationID="updateTeamMember" method="patch" path="/v1/teams/{teamId}/members/{uid}" -->
466
472
  ```typescript
467
473
  import { Vercel } from "@vercel/sdk";
468
474
 
@@ -576,6 +582,7 @@ Remove a Team Member from the Team, or dismiss a user that requested access, or
576
582
 
577
583
  ### Example Usage
578
584
 
585
+ <!-- UsageSnippet language="typescript" operationID="removeTeamMember" method="delete" path="/v1/teams/{teamId}/members/{uid}" -->
579
586
  ```typescript
580
587
  import { Vercel } from "@vercel/sdk";
581
588
 
@@ -655,6 +662,7 @@ Get information for the Team specified by the `teamId` parameter.
655
662
 
656
663
  ### Example Usage
657
664
 
665
+ <!-- UsageSnippet language="typescript" operationID="getTeam" method="get" path="/v2/teams/{teamId}" -->
658
666
  ```typescript
659
667
  import { Vercel } from "@vercel/sdk";
660
668
 
@@ -732,6 +740,7 @@ Update the information of a Team specified by the `teamId` parameter. The reques
732
740
 
733
741
  ### Example Usage
734
742
 
743
+ <!-- UsageSnippet language="typescript" operationID="patchTeam" method="patch" path="/v2/teams/{teamId}" -->
735
744
  ```typescript
736
745
  import { Vercel } from "@vercel/sdk";
737
746
 
@@ -846,6 +855,7 @@ Get a paginated list of all the Teams the authenticated User is a member of.
846
855
 
847
856
  ### Example Usage
848
857
 
858
+ <!-- UsageSnippet language="typescript" operationID="getTeams" method="get" path="/v2/teams" -->
849
859
  ```typescript
850
860
  import { Vercel } from "@vercel/sdk";
851
861
 
@@ -924,6 +934,7 @@ Create a new Team under your account. You need to send a POST request with the d
924
934
 
925
935
  ### Example Usage
926
936
 
937
+ <!-- UsageSnippet language="typescript" operationID="createTeam" method="post" path="/v1/teams" -->
927
938
  ```typescript
928
939
  import { Vercel } from "@vercel/sdk";
929
940
 
@@ -1000,6 +1011,7 @@ Delete a team under your account. You need to send a `DELETE` request with the d
1000
1011
 
1001
1012
  ### Example Usage
1002
1013
 
1014
+ <!-- UsageSnippet language="typescript" operationID="deleteTeam" method="delete" path="/v1/teams/{teamId}" -->
1003
1015
  ```typescript
1004
1016
  import { Vercel } from "@vercel/sdk";
1005
1017
 
@@ -1080,6 +1092,7 @@ Delete an active Team invite code.
1080
1092
 
1081
1093
  ### Example Usage
1082
1094
 
1095
+ <!-- UsageSnippet language="typescript" operationID="deleteTeamInviteCode" method="delete" path="/v1/teams/{teamId}/invites/{inviteId}" -->
1083
1096
  ```typescript
1084
1097
  import { Vercel } from "@vercel/sdk";
1085
1098
 
@@ -15,6 +15,7 @@ Retrieves a list of "events" generated by the User on Vercel. Events are generat
15
15
 
16
16
  ### Example Usage
17
17
 
18
+ <!-- UsageSnippet language="typescript" operationID="listUserEvents" method="get" path="/v3/events" -->
18
19
  ```typescript
19
20
  import { Vercel } from "@vercel/sdk";
20
21
 
@@ -107,6 +108,7 @@ Retrieves information related to the currently authenticated User.
107
108
 
108
109
  ### Example Usage
109
110
 
111
+ <!-- UsageSnippet language="typescript" operationID="getAuthUser" method="get" path="/v2/user" -->
110
112
  ```typescript
111
113
  import { Vercel } from "@vercel/sdk";
112
114
 
@@ -176,6 +178,7 @@ Initiates the deletion process for the currently authenticated User, by sending
176
178
 
177
179
  ### Example Usage
178
180
 
181
+ <!-- UsageSnippet language="typescript" operationID="requestDelete" method="delete" path="/v1/user" -->
179
182
  ```typescript
180
183
  import { Vercel } from "@vercel/sdk";
181
184