@vercel/sdk 1.12.2 → 1.13.0

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 (321) hide show
  1. package/README.md +40 -3
  2. package/bin/mcp-server.js +4976 -1639
  3. package/bin/mcp-server.js.map +61 -12
  4. package/docs/sdks/domains/README.md +1 -0
  5. package/docs/sdks/domainsregistrar/README.md +1337 -0
  6. package/esm/__tests__/domains.test.js +6 -9
  7. package/esm/__tests__/domains.test.js.map +1 -1
  8. package/esm/__tests__/domainsregistrar.test.d.ts +2 -0
  9. package/esm/__tests__/domainsregistrar.test.d.ts.map +1 -0
  10. package/esm/__tests__/domainsregistrar.test.js +274 -0
  11. package/esm/__tests__/domainsregistrar.test.js.map +1 -0
  12. package/esm/__tests__/edgeconfig.test.js +6 -6
  13. package/esm/__tests__/edgeconfig.test.js.map +1 -1
  14. package/esm/__tests__/integrations.test.js +1 -1
  15. package/esm/__tests__/logdrains.test.js +7 -5
  16. package/esm/__tests__/logdrains.test.js.map +1 -1
  17. package/esm/__tests__/rollingrelease.test.js +2 -6
  18. package/esm/__tests__/rollingrelease.test.js.map +1 -1
  19. package/esm/__tests__/security.test.js +4 -4
  20. package/esm/__tests__/security.test.js.map +1 -1
  21. package/esm/funcs/domainsCheckDomainPrice.d.ts +2 -1
  22. package/esm/funcs/domainsCheckDomainPrice.d.ts.map +1 -1
  23. package/esm/funcs/domainsCheckDomainPrice.js +3 -2
  24. package/esm/funcs/domainsCheckDomainPrice.js.map +1 -1
  25. package/esm/funcs/domainsRegistrarBuyDomains.d.ts +21 -0
  26. package/esm/funcs/domainsRegistrarBuyDomains.d.ts.map +1 -0
  27. package/esm/funcs/domainsRegistrarBuyDomains.js +85 -0
  28. package/esm/funcs/domainsRegistrarBuyDomains.js.map +1 -0
  29. package/esm/funcs/domainsRegistrarBuySingleDomain.d.ts +21 -0
  30. package/esm/funcs/domainsRegistrarBuySingleDomain.d.ts.map +1 -0
  31. package/esm/funcs/domainsRegistrarBuySingleDomain.js +91 -0
  32. package/esm/funcs/domainsRegistrarBuySingleDomain.js.map +1 -0
  33. package/esm/funcs/domainsRegistrarGetBulkAvailability.d.ts +20 -0
  34. package/esm/funcs/domainsRegistrarGetBulkAvailability.d.ts.map +1 -0
  35. package/esm/funcs/domainsRegistrarGetBulkAvailability.js +84 -0
  36. package/esm/funcs/domainsRegistrarGetBulkAvailability.js.map +1 -0
  37. package/esm/funcs/domainsRegistrarGetContactInfoSchema.d.ts +20 -0
  38. package/esm/funcs/domainsRegistrarGetContactInfoSchema.d.ts.map +1 -0
  39. package/esm/funcs/domainsRegistrarGetContactInfoSchema.js +89 -0
  40. package/esm/funcs/domainsRegistrarGetContactInfoSchema.js.map +1 -0
  41. package/esm/funcs/domainsRegistrarGetDomainAuthCode.d.ts +22 -0
  42. package/esm/funcs/domainsRegistrarGetDomainAuthCode.d.ts.map +1 -0
  43. package/esm/funcs/domainsRegistrarGetDomainAuthCode.js +91 -0
  44. package/esm/funcs/domainsRegistrarGetDomainAuthCode.js.map +1 -0
  45. package/esm/funcs/domainsRegistrarGetDomainAvailability.d.ts +21 -0
  46. package/esm/funcs/domainsRegistrarGetDomainAvailability.d.ts.map +1 -0
  47. package/esm/funcs/domainsRegistrarGetDomainAvailability.js +90 -0
  48. package/esm/funcs/domainsRegistrarGetDomainAvailability.js.map +1 -0
  49. package/esm/funcs/domainsRegistrarGetDomainPrice.d.ts +20 -0
  50. package/esm/funcs/domainsRegistrarGetDomainPrice.d.ts.map +1 -0
  51. package/esm/funcs/domainsRegistrarGetDomainPrice.js +93 -0
  52. package/esm/funcs/domainsRegistrarGetDomainPrice.js.map +1 -0
  53. package/esm/funcs/domainsRegistrarGetDomainTransferIn.d.ts +22 -0
  54. package/esm/funcs/domainsRegistrarGetDomainTransferIn.d.ts.map +1 -0
  55. package/esm/funcs/domainsRegistrarGetDomainTransferIn.js +91 -0
  56. package/esm/funcs/domainsRegistrarGetDomainTransferIn.js.map +1 -0
  57. package/esm/funcs/domainsRegistrarGetOrder.d.ts +22 -0
  58. package/esm/funcs/domainsRegistrarGetOrder.d.ts.map +1 -0
  59. package/esm/funcs/domainsRegistrarGetOrder.js +91 -0
  60. package/esm/funcs/domainsRegistrarGetOrder.js.map +1 -0
  61. package/esm/funcs/domainsRegistrarGetSupportedTlds.d.ts +20 -0
  62. package/esm/funcs/domainsRegistrarGetSupportedTlds.d.ts.map +1 -0
  63. package/esm/funcs/domainsRegistrarGetSupportedTlds.js +75 -0
  64. package/esm/funcs/domainsRegistrarGetSupportedTlds.js.map +1 -0
  65. package/esm/funcs/domainsRegistrarGetTldPrice.d.ts +21 -0
  66. package/esm/funcs/domainsRegistrarGetTldPrice.d.ts.map +1 -0
  67. package/esm/funcs/domainsRegistrarGetTldPrice.js +94 -0
  68. package/esm/funcs/domainsRegistrarGetTldPrice.js.map +1 -0
  69. package/esm/funcs/domainsRegistrarRenewDomain.d.ts +22 -0
  70. package/esm/funcs/domainsRegistrarRenewDomain.d.ts.map +1 -0
  71. package/esm/funcs/domainsRegistrarRenewDomain.js +92 -0
  72. package/esm/funcs/domainsRegistrarRenewDomain.js.map +1 -0
  73. package/esm/funcs/domainsRegistrarTransferInDomain.d.ts +21 -0
  74. package/esm/funcs/domainsRegistrarTransferInDomain.d.ts.map +1 -0
  75. package/esm/funcs/domainsRegistrarTransferInDomain.js +91 -0
  76. package/esm/funcs/domainsRegistrarTransferInDomain.js.map +1 -0
  77. package/esm/funcs/domainsRegistrarUpdateDomainAutoRenew.d.ts +22 -0
  78. package/esm/funcs/domainsRegistrarUpdateDomainAutoRenew.d.ts.map +1 -0
  79. package/esm/funcs/domainsRegistrarUpdateDomainAutoRenew.js +93 -0
  80. package/esm/funcs/domainsRegistrarUpdateDomainAutoRenew.js.map +1 -0
  81. package/esm/funcs/domainsRegistrarUpdateDomainNameservers.d.ts +22 -0
  82. package/esm/funcs/domainsRegistrarUpdateDomainNameservers.d.ts.map +1 -0
  83. package/esm/funcs/domainsRegistrarUpdateDomainNameservers.js +93 -0
  84. package/esm/funcs/domainsRegistrarUpdateDomainNameservers.js.map +1 -0
  85. package/esm/lib/config.d.ts +3 -3
  86. package/esm/lib/config.js +3 -3
  87. package/esm/mcp-server/mcp-server.js +1 -1
  88. package/esm/mcp-server/server.d.ts.map +1 -1
  89. package/esm/mcp-server/server.js +31 -1
  90. package/esm/mcp-server/server.js.map +1 -1
  91. package/esm/mcp-server/tools/domainsRegistrarBuyDomains.d.ts +7 -0
  92. package/esm/mcp-server/tools/domainsRegistrarBuyDomains.d.ts.map +1 -0
  93. package/esm/mcp-server/tools/domainsRegistrarBuyDomains.js +28 -0
  94. package/esm/mcp-server/tools/domainsRegistrarBuyDomains.js.map +1 -0
  95. package/esm/mcp-server/tools/domainsRegistrarBuySingleDomain.d.ts +7 -0
  96. package/esm/mcp-server/tools/domainsRegistrarBuySingleDomain.d.ts.map +1 -0
  97. package/esm/mcp-server/tools/domainsRegistrarBuySingleDomain.js +28 -0
  98. package/esm/mcp-server/tools/domainsRegistrarBuySingleDomain.js.map +1 -0
  99. package/esm/mcp-server/tools/domainsRegistrarGetBulkAvailability.d.ts +7 -0
  100. package/esm/mcp-server/tools/domainsRegistrarGetBulkAvailability.d.ts.map +1 -0
  101. package/esm/mcp-server/tools/domainsRegistrarGetBulkAvailability.js +28 -0
  102. package/esm/mcp-server/tools/domainsRegistrarGetBulkAvailability.js.map +1 -0
  103. package/esm/mcp-server/tools/domainsRegistrarGetContactInfoSchema.d.ts +7 -0
  104. package/esm/mcp-server/tools/domainsRegistrarGetContactInfoSchema.d.ts.map +1 -0
  105. package/esm/mcp-server/tools/domainsRegistrarGetContactInfoSchema.js +28 -0
  106. package/esm/mcp-server/tools/domainsRegistrarGetContactInfoSchema.js.map +1 -0
  107. package/esm/mcp-server/tools/domainsRegistrarGetDomainAuthCode.d.ts +7 -0
  108. package/esm/mcp-server/tools/domainsRegistrarGetDomainAuthCode.d.ts.map +1 -0
  109. package/esm/mcp-server/tools/domainsRegistrarGetDomainAuthCode.js +28 -0
  110. package/esm/mcp-server/tools/domainsRegistrarGetDomainAuthCode.js.map +1 -0
  111. package/esm/mcp-server/tools/domainsRegistrarGetDomainAvailability.d.ts +7 -0
  112. package/esm/mcp-server/tools/domainsRegistrarGetDomainAvailability.d.ts.map +1 -0
  113. package/esm/mcp-server/tools/domainsRegistrarGetDomainAvailability.js +28 -0
  114. package/esm/mcp-server/tools/domainsRegistrarGetDomainAvailability.js.map +1 -0
  115. package/esm/mcp-server/tools/domainsRegistrarGetDomainPrice.d.ts +7 -0
  116. package/esm/mcp-server/tools/domainsRegistrarGetDomainPrice.d.ts.map +1 -0
  117. package/esm/mcp-server/tools/domainsRegistrarGetDomainPrice.js +28 -0
  118. package/esm/mcp-server/tools/domainsRegistrarGetDomainPrice.js.map +1 -0
  119. package/esm/mcp-server/tools/domainsRegistrarGetDomainTransferIn.d.ts +7 -0
  120. package/esm/mcp-server/tools/domainsRegistrarGetDomainTransferIn.d.ts.map +1 -0
  121. package/esm/mcp-server/tools/domainsRegistrarGetDomainTransferIn.js +28 -0
  122. package/esm/mcp-server/tools/domainsRegistrarGetDomainTransferIn.js.map +1 -0
  123. package/esm/mcp-server/tools/domainsRegistrarGetOrder.d.ts +7 -0
  124. package/esm/mcp-server/tools/domainsRegistrarGetOrder.d.ts.map +1 -0
  125. package/esm/mcp-server/tools/domainsRegistrarGetOrder.js +28 -0
  126. package/esm/mcp-server/tools/domainsRegistrarGetOrder.js.map +1 -0
  127. package/esm/mcp-server/tools/domainsRegistrarGetSupportedTlds.d.ts +3 -0
  128. package/esm/mcp-server/tools/domainsRegistrarGetSupportedTlds.d.ts.map +1 -0
  129. package/esm/mcp-server/tools/domainsRegistrarGetSupportedTlds.js +23 -0
  130. package/esm/mcp-server/tools/domainsRegistrarGetSupportedTlds.js.map +1 -0
  131. package/esm/mcp-server/tools/domainsRegistrarGetTldPrice.d.ts +7 -0
  132. package/esm/mcp-server/tools/domainsRegistrarGetTldPrice.d.ts.map +1 -0
  133. package/esm/mcp-server/tools/domainsRegistrarGetTldPrice.js +28 -0
  134. package/esm/mcp-server/tools/domainsRegistrarGetTldPrice.js.map +1 -0
  135. package/esm/mcp-server/tools/domainsRegistrarRenewDomain.d.ts +7 -0
  136. package/esm/mcp-server/tools/domainsRegistrarRenewDomain.d.ts.map +1 -0
  137. package/esm/mcp-server/tools/domainsRegistrarRenewDomain.js +28 -0
  138. package/esm/mcp-server/tools/domainsRegistrarRenewDomain.js.map +1 -0
  139. package/esm/mcp-server/tools/domainsRegistrarTransferInDomain.d.ts +7 -0
  140. package/esm/mcp-server/tools/domainsRegistrarTransferInDomain.d.ts.map +1 -0
  141. package/esm/mcp-server/tools/domainsRegistrarTransferInDomain.js +28 -0
  142. package/esm/mcp-server/tools/domainsRegistrarTransferInDomain.js.map +1 -0
  143. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainAutoRenew.d.ts +7 -0
  144. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainAutoRenew.d.ts.map +1 -0
  145. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainAutoRenew.js +27 -0
  146. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainAutoRenew.js.map +1 -0
  147. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainNameservers.d.ts +7 -0
  148. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainNameservers.d.ts.map +1 -0
  149. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainNameservers.js +27 -0
  150. package/esm/mcp-server/tools/domainsRegistrarUpdateDomainNameservers.js.map +1 -0
  151. package/esm/models/buydomainsop.d.ts +282 -0
  152. package/esm/models/buydomainsop.d.ts.map +1 -0
  153. package/esm/models/buydomainsop.js +247 -0
  154. package/esm/models/buydomainsop.js.map +1 -0
  155. package/esm/models/buysingledomainop.d.ts +282 -0
  156. package/esm/models/buysingledomainop.d.ts.map +1 -0
  157. package/esm/models/buysingledomainop.js +257 -0
  158. package/esm/models/buysingledomainop.js.map +1 -0
  159. package/esm/models/createintegrationstoredirectop.d.ts +285 -285
  160. package/esm/models/createintegrationstoredirectop.js +351 -351
  161. package/esm/models/createprojectop.d.ts +30 -30
  162. package/esm/models/createprojectop.d.ts.map +1 -1
  163. package/esm/models/createprojectop.js +18 -18
  164. package/esm/models/createprojectop.js.map +1 -1
  165. package/esm/models/forbidden.d.ts +89 -0
  166. package/esm/models/forbidden.d.ts.map +1 -0
  167. package/esm/models/forbidden.js +98 -0
  168. package/esm/models/forbidden.js.map +1 -0
  169. package/esm/models/getbulkavailabilityop.d.ts +114 -0
  170. package/esm/models/getbulkavailabilityop.d.ts.map +1 -0
  171. package/esm/models/getbulkavailabilityop.js +115 -0
  172. package/esm/models/getbulkavailabilityop.js.map +1 -0
  173. package/esm/models/getconfigurationproductsop.d.ts +375 -375
  174. package/esm/models/getconfigurationproductsop.js +465 -465
  175. package/esm/models/getcontactinfoschemaop.d.ts +80 -0
  176. package/esm/models/getcontactinfoschemaop.d.ts.map +1 -0
  177. package/esm/models/getcontactinfoschemaop.js +84 -0
  178. package/esm/models/getcontactinfoschemaop.js.map +1 -0
  179. package/esm/models/getdomainauthcodeop.d.ts +84 -0
  180. package/esm/models/getdomainauthcodeop.d.ts.map +1 -0
  181. package/esm/models/getdomainauthcodeop.js +88 -0
  182. package/esm/models/getdomainauthcodeop.js.map +1 -0
  183. package/esm/models/getdomainavailabilityop.d.ts +84 -0
  184. package/esm/models/getdomainavailabilityop.d.ts.map +1 -0
  185. package/esm/models/getdomainavailabilityop.js +88 -0
  186. package/esm/models/getdomainavailabilityop.js.map +1 -0
  187. package/esm/models/getdomainpriceop.d.ts +101 -0
  188. package/esm/models/getdomainpriceop.d.ts.map +1 -0
  189. package/esm/models/getdomainpriceop.js +96 -0
  190. package/esm/models/getdomainpriceop.js.map +1 -0
  191. package/esm/models/getdomainsop.d.ts +15 -15
  192. package/esm/models/getdomainsop.d.ts.map +1 -1
  193. package/esm/models/getdomainsop.js +15 -15
  194. package/esm/models/getdomainsop.js.map +1 -1
  195. package/esm/models/getdomaintransferinop.d.ts +140 -0
  196. package/esm/models/getdomaintransferinop.d.ts.map +1 -0
  197. package/esm/models/getdomaintransferinop.js +117 -0
  198. package/esm/models/getdomaintransferinop.js.map +1 -0
  199. package/esm/models/getorderop.d.ts +715 -0
  200. package/esm/models/getorderop.d.ts.map +1 -0
  201. package/esm/models/getorderop.js +679 -0
  202. package/esm/models/getorderop.js.map +1 -0
  203. package/esm/models/getsupportedtldsop.d.ts +31 -0
  204. package/esm/models/getsupportedtldsop.d.ts.map +1 -0
  205. package/esm/models/getsupportedtldsop.js +38 -0
  206. package/esm/models/getsupportedtldsop.js.map +1 -0
  207. package/esm/models/gettldpriceop.d.ts +101 -0
  208. package/esm/models/gettldpriceop.d.ts.map +1 -0
  209. package/esm/models/gettldpriceop.js +96 -0
  210. package/esm/models/gettldpriceop.js.map +1 -0
  211. package/esm/models/internalservererror.d.ts +89 -0
  212. package/esm/models/internalservererror.d.ts.map +1 -0
  213. package/esm/models/internalservererror.js +98 -0
  214. package/esm/models/internalservererror.js.map +1 -0
  215. package/esm/models/notauthorizedforscope.d.ts +89 -0
  216. package/esm/models/notauthorizedforscope.d.ts.map +1 -0
  217. package/esm/models/notauthorizedforscope.js +98 -0
  218. package/esm/models/notauthorizedforscope.js.map +1 -0
  219. package/esm/models/renewdomainop.d.ts +257 -0
  220. package/esm/models/renewdomainop.d.ts.map +1 -0
  221. package/esm/models/renewdomainop.js +232 -0
  222. package/esm/models/renewdomainop.js.map +1 -0
  223. package/esm/models/transferindomainop.d.ts +261 -0
  224. package/esm/models/transferindomainop.d.ts.map +1 -0
  225. package/esm/models/transferindomainop.js +234 -0
  226. package/esm/models/transferindomainop.js.map +1 -0
  227. package/esm/models/unauthorized.d.ts +89 -0
  228. package/esm/models/unauthorized.d.ts.map +1 -0
  229. package/esm/models/unauthorized.js +98 -0
  230. package/esm/models/unauthorized.js.map +1 -0
  231. package/esm/models/updatedomainautorenewop.d.ts +83 -0
  232. package/esm/models/updatedomainautorenewop.d.ts.map +1 -0
  233. package/esm/models/updatedomainautorenewop.js +99 -0
  234. package/esm/models/updatedomainautorenewop.js.map +1 -0
  235. package/esm/models/updatedomainnameserversop.d.ts +83 -0
  236. package/esm/models/updatedomainnameserversop.d.ts.map +1 -0
  237. package/esm/models/updatedomainnameserversop.js +99 -0
  238. package/esm/models/updatedomainnameserversop.js.map +1 -0
  239. package/esm/models/updateprojectop.d.ts +30 -30
  240. package/esm/models/updateprojectop.d.ts.map +1 -1
  241. package/esm/models/updateprojectop.js +18 -18
  242. package/esm/models/updateprojectop.js.map +1 -1
  243. package/esm/sdk/domainsregistrar.d.ts +123 -0
  244. package/esm/sdk/domainsregistrar.d.ts.map +1 -0
  245. package/esm/sdk/domainsregistrar.js +158 -0
  246. package/esm/sdk/domainsregistrar.js.map +1 -0
  247. package/esm/sdk/sdk.d.ts +3 -0
  248. package/esm/sdk/sdk.d.ts.map +1 -1
  249. package/esm/sdk/sdk.js +4 -0
  250. package/esm/sdk/sdk.js.map +1 -1
  251. package/examples/package-lock.json +1 -1
  252. package/jsr.json +1 -1
  253. package/package.json +1 -1
  254. package/src/__tests__/domains.test.ts +6 -9
  255. package/src/__tests__/domainsregistrar.test.ts +313 -0
  256. package/src/__tests__/edgeconfig.test.ts +6 -6
  257. package/src/__tests__/integrations.test.ts +1 -1
  258. package/src/__tests__/logdrains.test.ts +7 -5
  259. package/src/__tests__/rollingrelease.test.ts +2 -6
  260. package/src/__tests__/security.test.ts +4 -4
  261. package/src/funcs/domainsCheckDomainPrice.ts +9 -1
  262. package/src/funcs/domainsRegistrarBuyDomains.ts +204 -0
  263. package/src/funcs/domainsRegistrarBuySingleDomain.ts +211 -0
  264. package/src/funcs/domainsRegistrarGetBulkAvailability.ts +202 -0
  265. package/src/funcs/domainsRegistrarGetContactInfoSchema.ts +210 -0
  266. package/src/funcs/domainsRegistrarGetDomainAuthCode.ts +220 -0
  267. package/src/funcs/domainsRegistrarGetDomainAvailability.ts +218 -0
  268. package/src/funcs/domainsRegistrarGetDomainPrice.ts +210 -0
  269. package/src/funcs/domainsRegistrarGetDomainTransferIn.ts +223 -0
  270. package/src/funcs/domainsRegistrarGetOrder.ts +218 -0
  271. package/src/funcs/domainsRegistrarGetSupportedTlds.ts +178 -0
  272. package/src/funcs/domainsRegistrarGetTldPrice.ts +218 -0
  273. package/src/funcs/domainsRegistrarRenewDomain.ts +219 -0
  274. package/src/funcs/domainsRegistrarTransferInDomain.ts +213 -0
  275. package/src/funcs/domainsRegistrarUpdateDomainAutoRenew.ts +220 -0
  276. package/src/funcs/domainsRegistrarUpdateDomainNameservers.ts +220 -0
  277. package/src/lib/config.ts +3 -3
  278. package/src/mcp-server/mcp-server.ts +1 -1
  279. package/src/mcp-server/server.ts +31 -1
  280. package/src/mcp-server/tools/domainsRegistrarBuyDomains.ts +37 -0
  281. package/src/mcp-server/tools/domainsRegistrarBuySingleDomain.ts +38 -0
  282. package/src/mcp-server/tools/domainsRegistrarGetBulkAvailability.ts +39 -0
  283. package/src/mcp-server/tools/domainsRegistrarGetContactInfoSchema.ts +40 -0
  284. package/src/mcp-server/tools/domainsRegistrarGetDomainAuthCode.ts +39 -0
  285. package/src/mcp-server/tools/domainsRegistrarGetDomainAvailability.ts +39 -0
  286. package/src/mcp-server/tools/domainsRegistrarGetDomainPrice.ts +38 -0
  287. package/src/mcp-server/tools/domainsRegistrarGetDomainTransferIn.ts +39 -0
  288. package/src/mcp-server/tools/domainsRegistrarGetOrder.ts +37 -0
  289. package/src/mcp-server/tools/domainsRegistrarGetSupportedTlds.ts +30 -0
  290. package/src/mcp-server/tools/domainsRegistrarGetTldPrice.ts +37 -0
  291. package/src/mcp-server/tools/domainsRegistrarRenewDomain.ts +37 -0
  292. package/src/mcp-server/tools/domainsRegistrarTransferInDomain.ts +39 -0
  293. package/src/mcp-server/tools/domainsRegistrarUpdateDomainAutoRenew.ts +37 -0
  294. package/src/mcp-server/tools/domainsRegistrarUpdateDomainNameservers.ts +37 -0
  295. package/src/models/buydomainsop.ts +582 -0
  296. package/src/models/buysingledomainop.ts +593 -0
  297. package/src/models/createintegrationstoredirectop.ts +604 -604
  298. package/src/models/createprojectop.ts +30 -30
  299. package/src/models/forbidden.ts +155 -0
  300. package/src/models/getbulkavailabilityop.ts +288 -0
  301. package/src/models/getconfigurationproductsop.ts +802 -802
  302. package/src/models/getcontactinfoschemaop.ts +222 -0
  303. package/src/models/getdomainauthcodeop.ts +227 -0
  304. package/src/models/getdomainavailabilityop.ts +231 -0
  305. package/src/models/getdomainpriceop.ts +247 -0
  306. package/src/models/getdomainsop.ts +50 -43
  307. package/src/models/getdomaintransferinop.ts +268 -0
  308. package/src/models/getorderop.ts +1298 -0
  309. package/src/models/getsupportedtldsop.ts +95 -0
  310. package/src/models/gettldpriceop.ts +248 -0
  311. package/src/models/internalservererror.ts +159 -0
  312. package/src/models/notauthorizedforscope.ts +161 -0
  313. package/src/models/renewdomainop.ts +548 -0
  314. package/src/models/transferindomainop.ts +566 -0
  315. package/src/models/unauthorized.ts +153 -0
  316. package/src/models/updatedomainautorenewop.ts +229 -0
  317. package/src/models/updatedomainnameserversop.ts +233 -0
  318. package/src/models/updateprojectop.ts +30 -30
  319. package/src/sdk/domainsregistrar.ts +323 -0
  320. package/src/sdk/sdk.ts +6 -0
  321. package/vercel-spec.json +3309 -215
@@ -0,0 +1,1337 @@
1
+ # DomainsRegistrar
2
+ (*domainsRegistrar*)
3
+
4
+ ## Overview
5
+
6
+ API Endpoints for working with and managing registered domains on Vercel
7
+
8
+ ### Available Operations
9
+
10
+ * [getSupportedTlds](#getsupportedtlds) - Get a list of TLDs supported by Vercel
11
+ * [getTldPrice](#gettldprice) - Get price data for a specific TLD
12
+ * [getDomainAvailability](#getdomainavailability) - Get availability for a specific domain
13
+ * [getDomainPrice](#getdomainprice) - Get price data for a specific domain
14
+ * [getBulkAvailability](#getbulkavailability) - Get availability for multiple domains
15
+ * [getDomainAuthCode](#getdomainauthcode) - Get the auth code for a domain
16
+ * [buySingleDomain](#buysingledomain) - Buy a domain
17
+ * [buyDomains](#buydomains) - Buy multiple domains at once
18
+ * [transferInDomain](#transferindomain) - Transfer a domain in from another registrar
19
+ * [getDomainTransferIn](#getdomaintransferin) - Get the transfer status for a domain
20
+ * [renewDomain](#renewdomain) - Renew a domain
21
+ * [updateDomainAutoRenew](#updatedomainautorenew) - Update the auto-renew setting for a domain
22
+ * [updateDomainNameservers](#updatedomainnameservers) - Update the nameservers for a domain
23
+ * [getContactInfoSchema](#getcontactinfoschema) - Get the schema for the tld-specific contact information for a domain
24
+ * [getOrder](#getorder) - Get information about a domain order by its ID
25
+
26
+ ## getSupportedTlds
27
+
28
+ Get supported TLDs
29
+
30
+ ### Example Usage
31
+
32
+ <!-- UsageSnippet language="typescript" operationID="getSupportedTlds" method="get" path="/v1/registrar/tlds/supported" -->
33
+ ```typescript
34
+ import { Vercel } from "@vercel/sdk";
35
+
36
+ const vercel = new Vercel({
37
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
38
+ });
39
+
40
+ async function run() {
41
+ const result = await vercel.domainsRegistrar.getSupportedTlds();
42
+
43
+ console.log(result);
44
+ }
45
+
46
+ run();
47
+ ```
48
+
49
+ ### Standalone function
50
+
51
+ The standalone function version of this method:
52
+
53
+ ```typescript
54
+ import { VercelCore } from "@vercel/sdk/core.js";
55
+ import { domainsRegistrarGetSupportedTlds } from "@vercel/sdk/funcs/domainsRegistrarGetSupportedTlds.js";
56
+
57
+ // Use `VercelCore` for best tree-shaking performance.
58
+ // You can create one instance of it to use across an application.
59
+ const vercel = new VercelCore({
60
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
61
+ });
62
+
63
+ async function run() {
64
+ const res = await domainsRegistrarGetSupportedTlds(vercel);
65
+ if (res.ok) {
66
+ const { value: result } = res;
67
+ console.log(result);
68
+ } else {
69
+ console.log("domainsRegistrarGetSupportedTlds failed:", res.error);
70
+ }
71
+ }
72
+
73
+ run();
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Parameter | Type | Required | Description |
79
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
80
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
81
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
82
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
83
+
84
+ ### Response
85
+
86
+ **Promise\<[string[]](../../models/.md)\>**
87
+
88
+ ### Errors
89
+
90
+ | Error Type | Status Code | Content Type |
91
+ | ---------------------------- | ---------------------------- | ---------------------------- |
92
+ | models.VercelBadRequestError | 400 | application/json |
93
+ | models.VercelForbiddenError | 401 | application/json |
94
+ | models.VercelRateLimitError | 429 | application/json |
95
+ | models.Unauthorized | 500 | application/json |
96
+ | models.NotAuthorizedForScope | 500 | application/json |
97
+ | models.InternalServerError | 500 | application/json |
98
+ | models.SDKError | 4XX, 5XX | \*/\* |
99
+
100
+ ## getTldPrice
101
+
102
+ Get TLD price data
103
+
104
+ ### Example Usage
105
+
106
+ <!-- UsageSnippet language="typescript" operationID="getTldPrice" method="get" path="/v1/registrar/tlds/{tld}/price" -->
107
+ ```typescript
108
+ import { Vercel } from "@vercel/sdk";
109
+
110
+ const vercel = new Vercel({
111
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
112
+ });
113
+
114
+ async function run() {
115
+ const result = await vercel.domainsRegistrar.getTldPrice({
116
+ tld: "<value>",
117
+ });
118
+
119
+ console.log(result);
120
+ }
121
+
122
+ run();
123
+ ```
124
+
125
+ ### Standalone function
126
+
127
+ The standalone function version of this method:
128
+
129
+ ```typescript
130
+ import { VercelCore } from "@vercel/sdk/core.js";
131
+ import { domainsRegistrarGetTldPrice } from "@vercel/sdk/funcs/domainsRegistrarGetTldPrice.js";
132
+
133
+ // Use `VercelCore` for best tree-shaking performance.
134
+ // You can create one instance of it to use across an application.
135
+ const vercel = new VercelCore({
136
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
137
+ });
138
+
139
+ async function run() {
140
+ const res = await domainsRegistrarGetTldPrice(vercel, {
141
+ tld: "<value>",
142
+ });
143
+ if (res.ok) {
144
+ const { value: result } = res;
145
+ console.log(result);
146
+ } else {
147
+ console.log("domainsRegistrarGetTldPrice failed:", res.error);
148
+ }
149
+ }
150
+
151
+ run();
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Parameter | Type | Required | Description |
157
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
+ | `request` | [models.GetTldPriceRequest](../../models/gettldpricerequest.md) | :heavy_check_mark: | The request object to use for the request. |
159
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
161
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
162
+
163
+ ### Response
164
+
165
+ **Promise\<[models.GetTldPriceResponseBody](../../models/gettldpriceresponsebody.md)\>**
166
+
167
+ ### Errors
168
+
169
+ | Error Type | Status Code | Content Type |
170
+ | ---------------------------- | ---------------------------- | ---------------------------- |
171
+ | models.VercelBadRequestError | 400 | application/json |
172
+ | models.VercelForbiddenError | 401 | application/json |
173
+ | models.VercelNotFoundError | 404 | application/json |
174
+ | models.VercelRateLimitError | 429 | application/json |
175
+ | models.Unauthorized | 500 | application/json |
176
+ | models.NotAuthorizedForScope | 500 | application/json |
177
+ | models.InternalServerError | 500 | application/json |
178
+ | models.SDKError | 4XX, 5XX | \*/\* |
179
+
180
+ ## getDomainAvailability
181
+
182
+ Get availability for a specific domain
183
+
184
+ ### Example Usage
185
+
186
+ <!-- UsageSnippet language="typescript" operationID="getDomainAvailability" method="get" path="/v1/registrar/domains/{domain}/availability" -->
187
+ ```typescript
188
+ import { Vercel } from "@vercel/sdk";
189
+
190
+ const vercel = new Vercel({
191
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
192
+ });
193
+
194
+ async function run() {
195
+ const result = await vercel.domainsRegistrar.getDomainAvailability({
196
+ domain: "hungry-birdbath.info",
197
+ });
198
+
199
+ console.log(result);
200
+ }
201
+
202
+ run();
203
+ ```
204
+
205
+ ### Standalone function
206
+
207
+ The standalone function version of this method:
208
+
209
+ ```typescript
210
+ import { VercelCore } from "@vercel/sdk/core.js";
211
+ import { domainsRegistrarGetDomainAvailability } from "@vercel/sdk/funcs/domainsRegistrarGetDomainAvailability.js";
212
+
213
+ // Use `VercelCore` for best tree-shaking performance.
214
+ // You can create one instance of it to use across an application.
215
+ const vercel = new VercelCore({
216
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
217
+ });
218
+
219
+ async function run() {
220
+ const res = await domainsRegistrarGetDomainAvailability(vercel, {
221
+ domain: "hungry-birdbath.info",
222
+ });
223
+ if (res.ok) {
224
+ const { value: result } = res;
225
+ console.log(result);
226
+ } else {
227
+ console.log("domainsRegistrarGetDomainAvailability failed:", res.error);
228
+ }
229
+ }
230
+
231
+ run();
232
+ ```
233
+
234
+ ### Parameters
235
+
236
+ | Parameter | Type | Required | Description |
237
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
238
+ | `request` | [models.GetDomainAvailabilityRequest](../../models/getdomainavailabilityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
239
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
240
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
241
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
242
+
243
+ ### Response
244
+
245
+ **Promise\<[models.GetDomainAvailabilityResponseBody](../../models/getdomainavailabilityresponsebody.md)\>**
246
+
247
+ ### Errors
248
+
249
+ | Error Type | Status Code | Content Type |
250
+ | ---------------------------- | ---------------------------- | ---------------------------- |
251
+ | models.VercelBadRequestError | 400 | application/json |
252
+ | models.VercelForbiddenError | 401 | application/json |
253
+ | models.VercelNotFoundError | 404 | application/json |
254
+ | models.VercelRateLimitError | 429 | application/json |
255
+ | models.Unauthorized | 500 | application/json |
256
+ | models.NotAuthorizedForScope | 500 | application/json |
257
+ | models.InternalServerError | 500 | application/json |
258
+ | models.SDKError | 4XX, 5XX | \*/\* |
259
+
260
+ ## getDomainPrice
261
+
262
+ Get price data for a specific domain
263
+
264
+ ### Example Usage
265
+
266
+ <!-- UsageSnippet language="typescript" operationID="getDomainPrice" method="get" path="/v1/registrar/domains/{domain}/price" -->
267
+ ```typescript
268
+ import { Vercel } from "@vercel/sdk";
269
+
270
+ const vercel = new Vercel({
271
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
272
+ });
273
+
274
+ async function run() {
275
+ const result = await vercel.domainsRegistrar.getDomainPrice({
276
+ domain: "excited-dwell.org",
277
+ });
278
+
279
+ console.log(result);
280
+ }
281
+
282
+ run();
283
+ ```
284
+
285
+ ### Standalone function
286
+
287
+ The standalone function version of this method:
288
+
289
+ ```typescript
290
+ import { VercelCore } from "@vercel/sdk/core.js";
291
+ import { domainsRegistrarGetDomainPrice } from "@vercel/sdk/funcs/domainsRegistrarGetDomainPrice.js";
292
+
293
+ // Use `VercelCore` for best tree-shaking performance.
294
+ // You can create one instance of it to use across an application.
295
+ const vercel = new VercelCore({
296
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
297
+ });
298
+
299
+ async function run() {
300
+ const res = await domainsRegistrarGetDomainPrice(vercel, {
301
+ domain: "excited-dwell.org",
302
+ });
303
+ if (res.ok) {
304
+ const { value: result } = res;
305
+ console.log(result);
306
+ } else {
307
+ console.log("domainsRegistrarGetDomainPrice failed:", res.error);
308
+ }
309
+ }
310
+
311
+ run();
312
+ ```
313
+
314
+ ### Parameters
315
+
316
+ | Parameter | Type | Required | Description |
317
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
318
+ | `request` | [models.GetDomainPriceRequest](../../models/getdomainpricerequest.md) | :heavy_check_mark: | The request object to use for the request. |
319
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
320
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
321
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
322
+
323
+ ### Response
324
+
325
+ **Promise\<[models.GetDomainPriceResponseBody](../../models/getdomainpriceresponsebody.md)\>**
326
+
327
+ ### Errors
328
+
329
+ | Error Type | Status Code | Content Type |
330
+ | ---------------------------- | ---------------------------- | ---------------------------- |
331
+ | models.VercelBadRequestError | 400 | application/json |
332
+ | models.VercelForbiddenError | 401 | application/json |
333
+ | models.VercelRateLimitError | 429 | application/json |
334
+ | models.Unauthorized | 500 | application/json |
335
+ | models.NotAuthorizedForScope | 500 | application/json |
336
+ | models.InternalServerError | 500 | application/json |
337
+ | models.SDKError | 4XX, 5XX | \*/\* |
338
+
339
+ ## getBulkAvailability
340
+
341
+ Get availability for multiple domains
342
+
343
+ ### Example Usage
344
+
345
+ <!-- UsageSnippet language="typescript" operationID="getBulkAvailability" method="post" path="/v1/registrar/domains/availability" -->
346
+ ```typescript
347
+ import { Vercel } from "@vercel/sdk";
348
+
349
+ const vercel = new Vercel({
350
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
351
+ });
352
+
353
+ async function run() {
354
+ const result = await vercel.domainsRegistrar.getBulkAvailability({
355
+ domains: [
356
+ "<value 1>",
357
+ ],
358
+ });
359
+
360
+ console.log(result);
361
+ }
362
+
363
+ run();
364
+ ```
365
+
366
+ ### Standalone function
367
+
368
+ The standalone function version of this method:
369
+
370
+ ```typescript
371
+ import { VercelCore } from "@vercel/sdk/core.js";
372
+ import { domainsRegistrarGetBulkAvailability } from "@vercel/sdk/funcs/domainsRegistrarGetBulkAvailability.js";
373
+
374
+ // Use `VercelCore` for best tree-shaking performance.
375
+ // You can create one instance of it to use across an application.
376
+ const vercel = new VercelCore({
377
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
378
+ });
379
+
380
+ async function run() {
381
+ const res = await domainsRegistrarGetBulkAvailability(vercel, {
382
+ domains: [
383
+ "<value 1>",
384
+ ],
385
+ });
386
+ if (res.ok) {
387
+ const { value: result } = res;
388
+ console.log(result);
389
+ } else {
390
+ console.log("domainsRegistrarGetBulkAvailability failed:", res.error);
391
+ }
392
+ }
393
+
394
+ run();
395
+ ```
396
+
397
+ ### Parameters
398
+
399
+ | Parameter | Type | Required | Description |
400
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
401
+ | `request` | [models.GetBulkAvailabilityRequestBody](../../models/getbulkavailabilityrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
402
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
403
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
404
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
405
+
406
+ ### Response
407
+
408
+ **Promise\<[models.GetBulkAvailabilityResponseBody](../../models/getbulkavailabilityresponsebody.md)\>**
409
+
410
+ ### Errors
411
+
412
+ | Error Type | Status Code | Content Type |
413
+ | ---------------------------- | ---------------------------- | ---------------------------- |
414
+ | models.VercelBadRequestError | 400 | application/json |
415
+ | models.VercelForbiddenError | 401 | application/json |
416
+ | models.VercelRateLimitError | 429 | application/json |
417
+ | models.Unauthorized | 500 | application/json |
418
+ | models.NotAuthorizedForScope | 500 | application/json |
419
+ | models.InternalServerError | 500 | application/json |
420
+ | models.SDKError | 4XX, 5XX | \*/\* |
421
+
422
+ ## getDomainAuthCode
423
+
424
+ Get the auth code for a domain
425
+
426
+ ### Example Usage
427
+
428
+ <!-- UsageSnippet language="typescript" operationID="getDomainAuthCode" method="get" path="/v1/registrar/domains/{domain}/auth-code" -->
429
+ ```typescript
430
+ import { Vercel } from "@vercel/sdk";
431
+
432
+ const vercel = new Vercel({
433
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
434
+ });
435
+
436
+ async function run() {
437
+ const result = await vercel.domainsRegistrar.getDomainAuthCode({
438
+ domain: "ruddy-coil.org",
439
+ });
440
+
441
+ console.log(result);
442
+ }
443
+
444
+ run();
445
+ ```
446
+
447
+ ### Standalone function
448
+
449
+ The standalone function version of this method:
450
+
451
+ ```typescript
452
+ import { VercelCore } from "@vercel/sdk/core.js";
453
+ import { domainsRegistrarGetDomainAuthCode } from "@vercel/sdk/funcs/domainsRegistrarGetDomainAuthCode.js";
454
+
455
+ // Use `VercelCore` for best tree-shaking performance.
456
+ // You can create one instance of it to use across an application.
457
+ const vercel = new VercelCore({
458
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
459
+ });
460
+
461
+ async function run() {
462
+ const res = await domainsRegistrarGetDomainAuthCode(vercel, {
463
+ domain: "ruddy-coil.org",
464
+ });
465
+ if (res.ok) {
466
+ const { value: result } = res;
467
+ console.log(result);
468
+ } else {
469
+ console.log("domainsRegistrarGetDomainAuthCode failed:", res.error);
470
+ }
471
+ }
472
+
473
+ run();
474
+ ```
475
+
476
+ ### Parameters
477
+
478
+ | Parameter | Type | Required | Description |
479
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
480
+ | `request` | [models.GetDomainAuthCodeRequest](../../models/getdomainauthcoderequest.md) | :heavy_check_mark: | The request object to use for the request. |
481
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
482
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
483
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
484
+
485
+ ### Response
486
+
487
+ **Promise\<[models.GetDomainAuthCodeResponseBody](../../models/getdomainauthcoderesponsebody.md)\>**
488
+
489
+ ### Errors
490
+
491
+ | Error Type | Status Code | Content Type |
492
+ | ---------------------------- | ---------------------------- | ---------------------------- |
493
+ | models.VercelBadRequestError | 400 | application/json |
494
+ | models.VercelForbiddenError | 401 | application/json |
495
+ | models.Forbidden | 403 | application/json |
496
+ | models.VercelNotFoundError | 404 | application/json |
497
+ | models.VercelRateLimitError | 429 | application/json |
498
+ | models.Unauthorized | 500 | application/json |
499
+ | models.NotAuthorizedForScope | 500 | application/json |
500
+ | models.InternalServerError | 500 | application/json |
501
+ | models.SDKError | 4XX, 5XX | \*/\* |
502
+
503
+ ## buySingleDomain
504
+
505
+ Buy a domain
506
+
507
+ ### Example Usage
508
+
509
+ <!-- UsageSnippet language="typescript" operationID="buySingleDomain" method="post" path="/v1/registrar/domains/{domain}/buy" -->
510
+ ```typescript
511
+ import { Vercel } from "@vercel/sdk";
512
+
513
+ const vercel = new Vercel({
514
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
515
+ });
516
+
517
+ async function run() {
518
+ const result = await vercel.domainsRegistrar.buySingleDomain({
519
+ domain: "metallic-simple.com",
520
+ requestBody: {
521
+ autoRenew: false,
522
+ years: 7602.67,
523
+ expectedPrice: 7390.34,
524
+ contactInformation: {
525
+ firstName: "Lexie",
526
+ lastName: "Lemke",
527
+ email: "Lionel21@gmail.com",
528
+ phone: "550.220.6330 x258",
529
+ address1: "<value>",
530
+ city: "Spencerport",
531
+ state: "West Virginia",
532
+ zip: "46432",
533
+ country: "Sweden",
534
+ },
535
+ },
536
+ });
537
+
538
+ console.log(result);
539
+ }
540
+
541
+ run();
542
+ ```
543
+
544
+ ### Standalone function
545
+
546
+ The standalone function version of this method:
547
+
548
+ ```typescript
549
+ import { VercelCore } from "@vercel/sdk/core.js";
550
+ import { domainsRegistrarBuySingleDomain } from "@vercel/sdk/funcs/domainsRegistrarBuySingleDomain.js";
551
+
552
+ // Use `VercelCore` for best tree-shaking performance.
553
+ // You can create one instance of it to use across an application.
554
+ const vercel = new VercelCore({
555
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
556
+ });
557
+
558
+ async function run() {
559
+ const res = await domainsRegistrarBuySingleDomain(vercel, {
560
+ domain: "metallic-simple.com",
561
+ requestBody: {
562
+ autoRenew: false,
563
+ years: 7602.67,
564
+ expectedPrice: 7390.34,
565
+ contactInformation: {
566
+ firstName: "Lexie",
567
+ lastName: "Lemke",
568
+ email: "Lionel21@gmail.com",
569
+ phone: "550.220.6330 x258",
570
+ address1: "<value>",
571
+ city: "Spencerport",
572
+ state: "West Virginia",
573
+ zip: "46432",
574
+ country: "Sweden",
575
+ },
576
+ },
577
+ });
578
+ if (res.ok) {
579
+ const { value: result } = res;
580
+ console.log(result);
581
+ } else {
582
+ console.log("domainsRegistrarBuySingleDomain failed:", res.error);
583
+ }
584
+ }
585
+
586
+ run();
587
+ ```
588
+
589
+ ### Parameters
590
+
591
+ | Parameter | Type | Required | Description |
592
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
593
+ | `request` | [models.BuySingleDomainRequest](../../models/buysingledomainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
594
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
595
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
596
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
597
+
598
+ ### Response
599
+
600
+ **Promise\<[models.BuySingleDomainResponseBody](../../models/buysingledomainresponsebody.md)\>**
601
+
602
+ ### Errors
603
+
604
+ | Error Type | Status Code | Content Type |
605
+ | ---------------------------- | ---------------------------- | ---------------------------- |
606
+ | models.VercelBadRequestError | 400 | application/json |
607
+ | models.VercelForbiddenError | 401 | application/json |
608
+ | models.Forbidden | 403 | application/json |
609
+ | models.VercelRateLimitError | 429 | application/json |
610
+ | models.Unauthorized | 500 | application/json |
611
+ | models.NotAuthorizedForScope | 500 | application/json |
612
+ | models.InternalServerError | 500 | application/json |
613
+ | models.SDKError | 4XX, 5XX | \*/\* |
614
+
615
+ ## buyDomains
616
+
617
+ Buy multiple domains
618
+
619
+ ### Example Usage
620
+
621
+ <!-- UsageSnippet language="typescript" operationID="buyDomains" method="post" path="/v1/registrar/domains/buy" -->
622
+ ```typescript
623
+ import { Vercel } from "@vercel/sdk";
624
+
625
+ const vercel = new Vercel({
626
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
627
+ });
628
+
629
+ async function run() {
630
+ const result = await vercel.domainsRegistrar.buyDomains({
631
+ domains: [],
632
+ contactInformation: {
633
+ firstName: "Leonie",
634
+ lastName: "Johnston",
635
+ email: "Anna_Fisher13@hotmail.com",
636
+ phone: "(688) 699-0656",
637
+ address1: "<value>",
638
+ city: "Rennerland",
639
+ state: "New Jersey",
640
+ zip: "70054",
641
+ country: "Peru",
642
+ },
643
+ });
644
+
645
+ console.log(result);
646
+ }
647
+
648
+ run();
649
+ ```
650
+
651
+ ### Standalone function
652
+
653
+ The standalone function version of this method:
654
+
655
+ ```typescript
656
+ import { VercelCore } from "@vercel/sdk/core.js";
657
+ import { domainsRegistrarBuyDomains } from "@vercel/sdk/funcs/domainsRegistrarBuyDomains.js";
658
+
659
+ // Use `VercelCore` for best tree-shaking performance.
660
+ // You can create one instance of it to use across an application.
661
+ const vercel = new VercelCore({
662
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
663
+ });
664
+
665
+ async function run() {
666
+ const res = await domainsRegistrarBuyDomains(vercel, {
667
+ domains: [],
668
+ contactInformation: {
669
+ firstName: "Leonie",
670
+ lastName: "Johnston",
671
+ email: "Anna_Fisher13@hotmail.com",
672
+ phone: "(688) 699-0656",
673
+ address1: "<value>",
674
+ city: "Rennerland",
675
+ state: "New Jersey",
676
+ zip: "70054",
677
+ country: "Peru",
678
+ },
679
+ });
680
+ if (res.ok) {
681
+ const { value: result } = res;
682
+ console.log(result);
683
+ } else {
684
+ console.log("domainsRegistrarBuyDomains failed:", res.error);
685
+ }
686
+ }
687
+
688
+ run();
689
+ ```
690
+
691
+ ### Parameters
692
+
693
+ | Parameter | Type | Required | Description |
694
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
695
+ | `request` | [models.BuyDomainsRequestBody](../../models/buydomainsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
696
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
697
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
698
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
699
+
700
+ ### Response
701
+
702
+ **Promise\<[models.BuyDomainsResponseBody](../../models/buydomainsresponsebody.md)\>**
703
+
704
+ ### Errors
705
+
706
+ | Error Type | Status Code | Content Type |
707
+ | ---------------------------- | ---------------------------- | ---------------------------- |
708
+ | models.VercelBadRequestError | 400 | application/json |
709
+ | models.VercelForbiddenError | 401 | application/json |
710
+ | models.Forbidden | 403 | application/json |
711
+ | models.VercelRateLimitError | 429 | application/json |
712
+ | models.Unauthorized | 500 | application/json |
713
+ | models.NotAuthorizedForScope | 500 | application/json |
714
+ | models.InternalServerError | 500 | application/json |
715
+ | models.SDKError | 4XX, 5XX | \*/\* |
716
+
717
+ ## transferInDomain
718
+
719
+ Transfer-in a domain
720
+
721
+ ### Example Usage
722
+
723
+ <!-- UsageSnippet language="typescript" operationID="transferInDomain" method="post" path="/v1/registrar/domains/{domain}/transfer" -->
724
+ ```typescript
725
+ import { Vercel } from "@vercel/sdk";
726
+
727
+ const vercel = new Vercel({
728
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
729
+ });
730
+
731
+ async function run() {
732
+ const result = await vercel.domainsRegistrar.transferInDomain({
733
+ domain: "silky-fund.org",
734
+ requestBody: {
735
+ authCode: "<value>",
736
+ autoRenew: true,
737
+ years: 298.08,
738
+ expectedPrice: 5092.5,
739
+ contactInformation: {
740
+ firstName: "Gabrielle",
741
+ lastName: "Hackett",
742
+ email: "Keshawn99@yahoo.com",
743
+ phone: "(758) 385-1802 x13762",
744
+ address1: "<value>",
745
+ city: "Pattiestead",
746
+ state: "Idaho",
747
+ zip: "64653-9022",
748
+ country: "Bolivia",
749
+ },
750
+ },
751
+ });
752
+
753
+ console.log(result);
754
+ }
755
+
756
+ run();
757
+ ```
758
+
759
+ ### Standalone function
760
+
761
+ The standalone function version of this method:
762
+
763
+ ```typescript
764
+ import { VercelCore } from "@vercel/sdk/core.js";
765
+ import { domainsRegistrarTransferInDomain } from "@vercel/sdk/funcs/domainsRegistrarTransferInDomain.js";
766
+
767
+ // Use `VercelCore` for best tree-shaking performance.
768
+ // You can create one instance of it to use across an application.
769
+ const vercel = new VercelCore({
770
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
771
+ });
772
+
773
+ async function run() {
774
+ const res = await domainsRegistrarTransferInDomain(vercel, {
775
+ domain: "silky-fund.org",
776
+ requestBody: {
777
+ authCode: "<value>",
778
+ autoRenew: true,
779
+ years: 298.08,
780
+ expectedPrice: 5092.5,
781
+ contactInformation: {
782
+ firstName: "Gabrielle",
783
+ lastName: "Hackett",
784
+ email: "Keshawn99@yahoo.com",
785
+ phone: "(758) 385-1802 x13762",
786
+ address1: "<value>",
787
+ city: "Pattiestead",
788
+ state: "Idaho",
789
+ zip: "64653-9022",
790
+ country: "Bolivia",
791
+ },
792
+ },
793
+ });
794
+ if (res.ok) {
795
+ const { value: result } = res;
796
+ console.log(result);
797
+ } else {
798
+ console.log("domainsRegistrarTransferInDomain failed:", res.error);
799
+ }
800
+ }
801
+
802
+ run();
803
+ ```
804
+
805
+ ### Parameters
806
+
807
+ | Parameter | Type | Required | Description |
808
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
809
+ | `request` | [models.TransferInDomainRequest](../../models/transferindomainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
810
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
811
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
812
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
813
+
814
+ ### Response
815
+
816
+ **Promise\<[models.TransferInDomainResponseBody](../../models/transferindomainresponsebody.md)\>**
817
+
818
+ ### Errors
819
+
820
+ | Error Type | Status Code | Content Type |
821
+ | ---------------------------- | ---------------------------- | ---------------------------- |
822
+ | models.VercelBadRequestError | 400 | application/json |
823
+ | models.VercelForbiddenError | 401 | application/json |
824
+ | models.Forbidden | 403 | application/json |
825
+ | models.VercelRateLimitError | 429 | application/json |
826
+ | models.Unauthorized | 500 | application/json |
827
+ | models.NotAuthorizedForScope | 500 | application/json |
828
+ | models.InternalServerError | 500 | application/json |
829
+ | models.SDKError | 4XX, 5XX | \*/\* |
830
+
831
+ ## getDomainTransferIn
832
+
833
+ Get a domain's transfer status
834
+
835
+ ### Example Usage
836
+
837
+ <!-- UsageSnippet language="typescript" operationID="getDomainTransferIn" method="get" path="/v1/registrar/domains/{domain}/transfer" -->
838
+ ```typescript
839
+ import { Vercel } from "@vercel/sdk";
840
+
841
+ const vercel = new Vercel({
842
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
843
+ });
844
+
845
+ async function run() {
846
+ const result = await vercel.domainsRegistrar.getDomainTransferIn({
847
+ domain: "unsung-antelope.com",
848
+ });
849
+
850
+ console.log(result);
851
+ }
852
+
853
+ run();
854
+ ```
855
+
856
+ ### Standalone function
857
+
858
+ The standalone function version of this method:
859
+
860
+ ```typescript
861
+ import { VercelCore } from "@vercel/sdk/core.js";
862
+ import { domainsRegistrarGetDomainTransferIn } from "@vercel/sdk/funcs/domainsRegistrarGetDomainTransferIn.js";
863
+
864
+ // Use `VercelCore` for best tree-shaking performance.
865
+ // You can create one instance of it to use across an application.
866
+ const vercel = new VercelCore({
867
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
868
+ });
869
+
870
+ async function run() {
871
+ const res = await domainsRegistrarGetDomainTransferIn(vercel, {
872
+ domain: "unsung-antelope.com",
873
+ });
874
+ if (res.ok) {
875
+ const { value: result } = res;
876
+ console.log(result);
877
+ } else {
878
+ console.log("domainsRegistrarGetDomainTransferIn failed:", res.error);
879
+ }
880
+ }
881
+
882
+ run();
883
+ ```
884
+
885
+ ### Parameters
886
+
887
+ | Parameter | Type | Required | Description |
888
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
889
+ | `request` | [models.GetDomainTransferInRequest](../../models/getdomaintransferinrequest.md) | :heavy_check_mark: | The request object to use for the request. |
890
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
891
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
892
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
893
+
894
+ ### Response
895
+
896
+ **Promise\<[models.GetDomainTransferInResponseBody](../../models/getdomaintransferinresponsebody.md)\>**
897
+
898
+ ### Errors
899
+
900
+ | Error Type | Status Code | Content Type |
901
+ | ---------------------------- | ---------------------------- | ---------------------------- |
902
+ | models.VercelBadRequestError | 400 | application/json |
903
+ | models.VercelForbiddenError | 401 | application/json |
904
+ | models.Forbidden | 403 | application/json |
905
+ | models.VercelNotFoundError | 404 | application/json |
906
+ | models.VercelRateLimitError | 429 | application/json |
907
+ | models.Unauthorized | 500 | application/json |
908
+ | models.NotAuthorizedForScope | 500 | application/json |
909
+ | models.InternalServerError | 500 | application/json |
910
+ | models.SDKError | 4XX, 5XX | \*/\* |
911
+
912
+ ## renewDomain
913
+
914
+ Renew a domain
915
+
916
+ ### Example Usage
917
+
918
+ <!-- UsageSnippet language="typescript" operationID="renewDomain" method="post" path="/v1/registrar/domains/{domain}/renew" -->
919
+ ```typescript
920
+ import { Vercel } from "@vercel/sdk";
921
+
922
+ const vercel = new Vercel({
923
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
924
+ });
925
+
926
+ async function run() {
927
+ const result = await vercel.domainsRegistrar.renewDomain({
928
+ domain: "scaly-daughter.biz",
929
+ requestBody: {
930
+ years: 1981.72,
931
+ expectedPrice: 7096.16,
932
+ },
933
+ });
934
+
935
+ console.log(result);
936
+ }
937
+
938
+ run();
939
+ ```
940
+
941
+ ### Standalone function
942
+
943
+ The standalone function version of this method:
944
+
945
+ ```typescript
946
+ import { VercelCore } from "@vercel/sdk/core.js";
947
+ import { domainsRegistrarRenewDomain } from "@vercel/sdk/funcs/domainsRegistrarRenewDomain.js";
948
+
949
+ // Use `VercelCore` for best tree-shaking performance.
950
+ // You can create one instance of it to use across an application.
951
+ const vercel = new VercelCore({
952
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
953
+ });
954
+
955
+ async function run() {
956
+ const res = await domainsRegistrarRenewDomain(vercel, {
957
+ domain: "scaly-daughter.biz",
958
+ requestBody: {
959
+ years: 1981.72,
960
+ expectedPrice: 7096.16,
961
+ },
962
+ });
963
+ if (res.ok) {
964
+ const { value: result } = res;
965
+ console.log(result);
966
+ } else {
967
+ console.log("domainsRegistrarRenewDomain failed:", res.error);
968
+ }
969
+ }
970
+
971
+ run();
972
+ ```
973
+
974
+ ### Parameters
975
+
976
+ | Parameter | Type | Required | Description |
977
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
978
+ | `request` | [models.RenewDomainRequest](../../models/renewdomainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
979
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
980
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
981
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
982
+
983
+ ### Response
984
+
985
+ **Promise\<[models.RenewDomainResponseBody](../../models/renewdomainresponsebody.md)\>**
986
+
987
+ ### Errors
988
+
989
+ | Error Type | Status Code | Content Type |
990
+ | ---------------------------- | ---------------------------- | ---------------------------- |
991
+ | models.VercelBadRequestError | 400 | application/json |
992
+ | models.VercelForbiddenError | 401 | application/json |
993
+ | models.Forbidden | 403 | application/json |
994
+ | models.VercelNotFoundError | 404 | application/json |
995
+ | models.VercelRateLimitError | 429 | application/json |
996
+ | models.Unauthorized | 500 | application/json |
997
+ | models.NotAuthorizedForScope | 500 | application/json |
998
+ | models.InternalServerError | 500 | application/json |
999
+ | models.SDKError | 4XX, 5XX | \*/\* |
1000
+
1001
+ ## updateDomainAutoRenew
1002
+
1003
+ Update auto-renew for a domain
1004
+
1005
+ ### Example Usage
1006
+
1007
+ <!-- UsageSnippet language="typescript" operationID="updateDomainAutoRenew" method="patch" path="/v1/registrar/domains/{domain}/auto-renew" -->
1008
+ ```typescript
1009
+ import { Vercel } from "@vercel/sdk";
1010
+
1011
+ const vercel = new Vercel({
1012
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1013
+ });
1014
+
1015
+ async function run() {
1016
+ await vercel.domainsRegistrar.updateDomainAutoRenew({
1017
+ domain: "worthwhile-dwell.net",
1018
+ requestBody: {
1019
+ autoRenew: true,
1020
+ },
1021
+ });
1022
+
1023
+
1024
+ }
1025
+
1026
+ run();
1027
+ ```
1028
+
1029
+ ### Standalone function
1030
+
1031
+ The standalone function version of this method:
1032
+
1033
+ ```typescript
1034
+ import { VercelCore } from "@vercel/sdk/core.js";
1035
+ import { domainsRegistrarUpdateDomainAutoRenew } from "@vercel/sdk/funcs/domainsRegistrarUpdateDomainAutoRenew.js";
1036
+
1037
+ // Use `VercelCore` for best tree-shaking performance.
1038
+ // You can create one instance of it to use across an application.
1039
+ const vercel = new VercelCore({
1040
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1041
+ });
1042
+
1043
+ async function run() {
1044
+ const res = await domainsRegistrarUpdateDomainAutoRenew(vercel, {
1045
+ domain: "worthwhile-dwell.net",
1046
+ requestBody: {
1047
+ autoRenew: true,
1048
+ },
1049
+ });
1050
+ if (res.ok) {
1051
+ const { value: result } = res;
1052
+
1053
+ } else {
1054
+ console.log("domainsRegistrarUpdateDomainAutoRenew failed:", res.error);
1055
+ }
1056
+ }
1057
+
1058
+ run();
1059
+ ```
1060
+
1061
+ ### Parameters
1062
+
1063
+ | Parameter | Type | Required | Description |
1064
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1065
+ | `request` | [models.UpdateDomainAutoRenewRequest](../../models/updatedomainautorenewrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1066
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1067
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1068
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1069
+
1070
+ ### Response
1071
+
1072
+ **Promise\<void\>**
1073
+
1074
+ ### Errors
1075
+
1076
+ | Error Type | Status Code | Content Type |
1077
+ | ---------------------------- | ---------------------------- | ---------------------------- |
1078
+ | models.VercelBadRequestError | 400 | application/json |
1079
+ | models.VercelForbiddenError | 401 | application/json |
1080
+ | models.Forbidden | 403 | application/json |
1081
+ | models.VercelNotFoundError | 404 | application/json |
1082
+ | models.VercelRateLimitError | 429 | application/json |
1083
+ | models.Unauthorized | 500 | application/json |
1084
+ | models.NotAuthorizedForScope | 500 | application/json |
1085
+ | models.InternalServerError | 500 | application/json |
1086
+ | models.SDKError | 4XX, 5XX | \*/\* |
1087
+
1088
+ ## updateDomainNameservers
1089
+
1090
+ Update nameservers for a domain
1091
+
1092
+ ### Example Usage
1093
+
1094
+ <!-- UsageSnippet language="typescript" operationID="updateDomainNameservers" method="patch" path="/v1/registrar/domains/{domain}/nameservers" -->
1095
+ ```typescript
1096
+ import { Vercel } from "@vercel/sdk";
1097
+
1098
+ const vercel = new Vercel({
1099
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1100
+ });
1101
+
1102
+ async function run() {
1103
+ await vercel.domainsRegistrar.updateDomainNameservers({
1104
+ domain: "unique-formula.biz",
1105
+ requestBody: {
1106
+ nameservers: [
1107
+ "<value 1>",
1108
+ ],
1109
+ },
1110
+ });
1111
+
1112
+
1113
+ }
1114
+
1115
+ run();
1116
+ ```
1117
+
1118
+ ### Standalone function
1119
+
1120
+ The standalone function version of this method:
1121
+
1122
+ ```typescript
1123
+ import { VercelCore } from "@vercel/sdk/core.js";
1124
+ import { domainsRegistrarUpdateDomainNameservers } from "@vercel/sdk/funcs/domainsRegistrarUpdateDomainNameservers.js";
1125
+
1126
+ // Use `VercelCore` for best tree-shaking performance.
1127
+ // You can create one instance of it to use across an application.
1128
+ const vercel = new VercelCore({
1129
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1130
+ });
1131
+
1132
+ async function run() {
1133
+ const res = await domainsRegistrarUpdateDomainNameservers(vercel, {
1134
+ domain: "unique-formula.biz",
1135
+ requestBody: {
1136
+ nameservers: [
1137
+ "<value 1>",
1138
+ ],
1139
+ },
1140
+ });
1141
+ if (res.ok) {
1142
+ const { value: result } = res;
1143
+
1144
+ } else {
1145
+ console.log("domainsRegistrarUpdateDomainNameservers failed:", res.error);
1146
+ }
1147
+ }
1148
+
1149
+ run();
1150
+ ```
1151
+
1152
+ ### Parameters
1153
+
1154
+ | Parameter | Type | Required | Description |
1155
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1156
+ | `request` | [models.UpdateDomainNameserversRequest](../../models/updatedomainnameserversrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1157
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1158
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1159
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1160
+
1161
+ ### Response
1162
+
1163
+ **Promise\<void\>**
1164
+
1165
+ ### Errors
1166
+
1167
+ | Error Type | Status Code | Content Type |
1168
+ | ---------------------------- | ---------------------------- | ---------------------------- |
1169
+ | models.VercelBadRequestError | 400 | application/json |
1170
+ | models.VercelForbiddenError | 401 | application/json |
1171
+ | models.Forbidden | 403 | application/json |
1172
+ | models.VercelNotFoundError | 404 | application/json |
1173
+ | models.VercelRateLimitError | 429 | application/json |
1174
+ | models.Unauthorized | 500 | application/json |
1175
+ | models.NotAuthorizedForScope | 500 | application/json |
1176
+ | models.InternalServerError | 500 | application/json |
1177
+ | models.SDKError | 4XX, 5XX | \*/\* |
1178
+
1179
+ ## getContactInfoSchema
1180
+
1181
+ Get contact info schema
1182
+
1183
+ ### Example Usage
1184
+
1185
+ <!-- UsageSnippet language="typescript" operationID="getContactInfoSchema" method="get" path="/v1/registrar/domains/{domain}/contact-info/schema" -->
1186
+ ```typescript
1187
+ import { Vercel } from "@vercel/sdk";
1188
+
1189
+ const vercel = new Vercel({
1190
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1191
+ });
1192
+
1193
+ async function run() {
1194
+ const result = await vercel.domainsRegistrar.getContactInfoSchema({
1195
+ domain: "tricky-issue.name",
1196
+ });
1197
+
1198
+ console.log(result);
1199
+ }
1200
+
1201
+ run();
1202
+ ```
1203
+
1204
+ ### Standalone function
1205
+
1206
+ The standalone function version of this method:
1207
+
1208
+ ```typescript
1209
+ import { VercelCore } from "@vercel/sdk/core.js";
1210
+ import { domainsRegistrarGetContactInfoSchema } from "@vercel/sdk/funcs/domainsRegistrarGetContactInfoSchema.js";
1211
+
1212
+ // Use `VercelCore` for best tree-shaking performance.
1213
+ // You can create one instance of it to use across an application.
1214
+ const vercel = new VercelCore({
1215
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1216
+ });
1217
+
1218
+ async function run() {
1219
+ const res = await domainsRegistrarGetContactInfoSchema(vercel, {
1220
+ domain: "tricky-issue.name",
1221
+ });
1222
+ if (res.ok) {
1223
+ const { value: result } = res;
1224
+ console.log(result);
1225
+ } else {
1226
+ console.log("domainsRegistrarGetContactInfoSchema failed:", res.error);
1227
+ }
1228
+ }
1229
+
1230
+ run();
1231
+ ```
1232
+
1233
+ ### Parameters
1234
+
1235
+ | Parameter | Type | Required | Description |
1236
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1237
+ | `request` | [models.GetContactInfoSchemaRequest](../../models/getcontactinfoschemarequest.md) | :heavy_check_mark: | The request object to use for the request. |
1238
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1239
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1240
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1241
+
1242
+ ### Response
1243
+
1244
+ **Promise\<[models.GetContactInfoSchemaResponseBody](../../models/getcontactinfoschemaresponsebody.md)\>**
1245
+
1246
+ ### Errors
1247
+
1248
+ | Error Type | Status Code | Content Type |
1249
+ | ---------------------------- | ---------------------------- | ---------------------------- |
1250
+ | models.VercelBadRequestError | 400 | application/json |
1251
+ | models.VercelForbiddenError | 401 | application/json |
1252
+ | models.VercelRateLimitError | 429 | application/json |
1253
+ | models.Unauthorized | 500 | application/json |
1254
+ | models.NotAuthorizedForScope | 500 | application/json |
1255
+ | models.InternalServerError | 500 | application/json |
1256
+ | models.SDKError | 4XX, 5XX | \*/\* |
1257
+
1258
+ ## getOrder
1259
+
1260
+ Get a domain order
1261
+
1262
+ ### Example Usage
1263
+
1264
+ <!-- UsageSnippet language="typescript" operationID="getOrder" method="get" path="/v1/registrar/orders/{orderId}" -->
1265
+ ```typescript
1266
+ import { Vercel } from "@vercel/sdk";
1267
+
1268
+ const vercel = new Vercel({
1269
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1270
+ });
1271
+
1272
+ async function run() {
1273
+ const result = await vercel.domainsRegistrar.getOrder({
1274
+ orderId: "<id>",
1275
+ });
1276
+
1277
+ console.log(result);
1278
+ }
1279
+
1280
+ run();
1281
+ ```
1282
+
1283
+ ### Standalone function
1284
+
1285
+ The standalone function version of this method:
1286
+
1287
+ ```typescript
1288
+ import { VercelCore } from "@vercel/sdk/core.js";
1289
+ import { domainsRegistrarGetOrder } from "@vercel/sdk/funcs/domainsRegistrarGetOrder.js";
1290
+
1291
+ // Use `VercelCore` for best tree-shaking performance.
1292
+ // You can create one instance of it to use across an application.
1293
+ const vercel = new VercelCore({
1294
+ bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
1295
+ });
1296
+
1297
+ async function run() {
1298
+ const res = await domainsRegistrarGetOrder(vercel, {
1299
+ orderId: "<id>",
1300
+ });
1301
+ if (res.ok) {
1302
+ const { value: result } = res;
1303
+ console.log(result);
1304
+ } else {
1305
+ console.log("domainsRegistrarGetOrder failed:", res.error);
1306
+ }
1307
+ }
1308
+
1309
+ run();
1310
+ ```
1311
+
1312
+ ### Parameters
1313
+
1314
+ | Parameter | Type | Required | Description |
1315
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1316
+ | `request` | [models.GetOrderRequest](../../models/getorderrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1317
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1318
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1319
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1320
+
1321
+ ### Response
1322
+
1323
+ **Promise\<[models.GetOrderResponseBody](../../models/getorderresponsebody.md)\>**
1324
+
1325
+ ### Errors
1326
+
1327
+ | Error Type | Status Code | Content Type |
1328
+ | ---------------------------- | ---------------------------- | ---------------------------- |
1329
+ | models.VercelBadRequestError | 400 | application/json |
1330
+ | models.VercelForbiddenError | 401 | application/json |
1331
+ | models.Forbidden | 403 | application/json |
1332
+ | models.VercelNotFoundError | 404 | application/json |
1333
+ | models.VercelRateLimitError | 429 | application/json |
1334
+ | models.Unauthorized | 500 | application/json |
1335
+ | models.NotAuthorizedForScope | 500 | application/json |
1336
+ | models.InternalServerError | 500 | application/json |
1337
+ | models.SDKError | 4XX, 5XX | \*/\* |