vercel-api-js 0.1.20 → 0.1.21

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.
@@ -1,10 +1,10 @@
1
1
 
2
- > vercel-api-js@0.1.20 build /home/runner/work/openapi-clients/openapi-clients/packages/vercel-api-js
2
+ > vercel-api-js@0.1.21 build /home/runner/work/openapi-clients/openapi-clients/packages/vercel-api-js
3
3
  > rimraf dist && rollup -c
4
4
 
5
5
  
6
6
  ./src/index.ts → dist/index.cjs, dist/index.mjs...
7
- created dist/index.cjs, dist/index.mjs in 6.5s
7
+ created dist/index.cjs, dist/index.mjs in 8.9s
8
8
  
9
9
  ./src/index.ts → dist/index.d.ts...
10
- created dist/index.d.ts in 7s
10
+ created dist/index.d.ts in 8.5s
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # vercel-api-js
2
2
 
3
+ ## 0.1.21
4
+
5
+ ### Patch Changes
6
+
7
+ - 8faaa44: [OpenAPI] Add patch domain endpoint
8
+ - 3b9bfd6: [OpenAPI] Add getDomainTransfer endpoint
9
+
3
10
  ## 0.1.20
4
11
 
5
12
  ### Patch Changes
package/dist/index.cjs CHANGED
@@ -245,6 +245,15 @@ const checkDomainStatus = (variables, signal) => fetch$1({
245
245
  ...variables,
246
246
  signal
247
247
  });
248
+ /**
249
+ * Fetch domain transfer availability or transfer status if a transfer is in progress.
250
+ */
251
+ const getDomainTransfer = (variables, signal) => fetch$1({
252
+ url: '/v1/domains/{domain}/registry',
253
+ method: 'get',
254
+ ...variables,
255
+ signal
256
+ });
248
257
  /**
249
258
  * Get a Domain's configuration.
250
259
  */
@@ -268,9 +277,13 @@ const getDomains = (variables, signal) => fetch$1({
268
277
  signal
269
278
  });
270
279
  /**
271
- * This endpoint is used for registering a new domain name with Vercel for the authenticating user, and also for initiating a domain transfer request from an external Registrar to Vercel.
280
+ * This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Can also be used for initiating a domain transfer request from an external Registrar to Vercel.
272
281
  */
273
282
  const createOrTransferDomain = (variables, signal) => fetch$1({ url: '/v5/domains', method: 'post', ...variables, signal });
283
+ /**
284
+ * Update or move apex domain.
285
+ */
286
+ const patchDomain = (variables, signal) => fetch$1({ url: '/v3/domains/{domain}', method: 'patch', ...variables, signal });
274
287
  /**
275
288
  * Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
276
289
  */
@@ -882,10 +895,12 @@ const operationsByTag = {
882
895
  buyDomain,
883
896
  checkDomainPrice,
884
897
  checkDomainStatus,
898
+ getDomainTransfer,
885
899
  getDomainConfig,
886
900
  getDomain,
887
901
  getDomains,
888
902
  createOrTransferDomain,
903
+ patchDomain,
889
904
  deleteDomain
890
905
  },
891
906
  dns: { getRecords, createRecord, updateRecord, removeRecord },
package/dist/index.d.ts CHANGED
@@ -5748,6 +5748,38 @@ type CheckDomainStatusVariables = {
5748
5748
  * Check if a domain name is available for purchase.
5749
5749
  */
5750
5750
  declare const checkDomainStatus: (variables: CheckDomainStatusVariables, signal?: AbortSignal) => Promise<CheckDomainStatusResponse>;
5751
+ type GetDomainTransferQueryParams = {
5752
+ /**
5753
+ * The Team identifier or slug to perform the request on behalf of.
5754
+ */
5755
+ teamId?: string;
5756
+ };
5757
+ type GetDomainTransferError = ErrorWrapper<undefined>;
5758
+ type GetDomainTransferResponse = {
5759
+ /**
5760
+ * Whether or not the domain is transferable
5761
+ */
5762
+ transferable: boolean;
5763
+ /**
5764
+ * The domain's transfer policy (depends on TLD requirements). `charge-and-renew`: transfer will charge for renewal and will renew the existing domain's registration. `no-charge-no-change`: transfer will have no change to registration period and does not require charge. `no-change`: transfer charge is required, but no change in registration period. `new-term`: transfer charge is required and a new registry term is set based on the transfer date. `not-supported`: transfers are not supported for this domain or TLD. `null`: This TLD is not supported by Vercel's Registrar.
5765
+ */
5766
+ transferPolicy: 'charge-and-renew' | 'no-charge-no-change' | 'no-change' | 'new-term' | 'not-supported' | null;
5767
+ /**
5768
+ * Description associated with transferable state.
5769
+ */
5770
+ reason: string;
5771
+ /**
5772
+ * The current state of an ongoing transfer. `pending_owner`: Awaiting approval by domain's admin contact (every transfer begins with this status). If approval is not given within five days, the transfer is cancelled. `pending_admin`: Waiting for approval by Vercel Registrar admin. `pending_registry`: Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar). `completed`: The transfer completed successfully. `cancelled`: The transfer was cancelled. `undef`: No transfer exists for this domain. `unknown`: This TLD is not supported by Vercel's Registrar.
5773
+ */
5774
+ status: 'pending_owner' | 'pending_admin' | 'pending_registry' | 'completed' | 'cancelled' | 'undef' | 'unknown';
5775
+ };
5776
+ type GetDomainTransferVariables = {
5777
+ queryParams?: GetDomainTransferQueryParams;
5778
+ } & FetcherExtraProps;
5779
+ /**
5780
+ * Fetch domain transfer availability or transfer status if a transfer is in progress.
5781
+ */
5782
+ declare const getDomainTransfer: (variables: GetDomainTransferVariables, signal?: AbortSignal) => Promise<GetDomainTransferResponse>;
5751
5783
  type GetDomainConfigPathParams = {
5752
5784
  /**
5753
5785
  * The name of the domain.
@@ -6160,6 +6192,26 @@ type CreateOrTransferDomainResponse = {
6160
6192
  };
6161
6193
  type CreateOrTransferDomainVariables = {
6162
6194
  body?: {
6195
+ /**
6196
+ * The domain name you want to add.
6197
+ *
6198
+ * @example example.com
6199
+ */
6200
+ name: string;
6201
+ /**
6202
+ * Whether the domain has the Vercel Edge Network enabled or not.
6203
+ *
6204
+ * @example true
6205
+ */
6206
+ cdnEnabled?: boolean;
6207
+ zone?: boolean;
6208
+ /**
6209
+ * The domain operation to perform.
6210
+ *
6211
+ * @example add
6212
+ */
6213
+ method?: string;
6214
+ } | {
6163
6215
  /**
6164
6216
  * The domain name you want to add.
6165
6217
  *
@@ -6203,33 +6255,71 @@ type CreateOrTransferDomainVariables = {
6203
6255
  * @example 8
6204
6256
  */
6205
6257
  expectedPrice?: number;
6206
- } | {
6258
+ };
6259
+ queryParams?: CreateOrTransferDomainQueryParams;
6260
+ } & FetcherExtraProps;
6261
+ /**
6262
+ * This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Can also be used for initiating a domain transfer request from an external Registrar to Vercel.
6263
+ */
6264
+ declare const createOrTransferDomain: (variables: CreateOrTransferDomainVariables, signal?: AbortSignal) => Promise<CreateOrTransferDomainResponse>;
6265
+ type PatchDomainPathParams = {
6266
+ domain?: string;
6267
+ };
6268
+ type PatchDomainQueryParams = {
6269
+ /**
6270
+ * The Team identifier or slug to perform the request on behalf of.
6271
+ */
6272
+ teamId?: string;
6273
+ };
6274
+ type PatchDomainError = ErrorWrapper<undefined>;
6275
+ type PatchDomainVariables = {
6276
+ body?: {
6207
6277
  /**
6208
- * The domain name you want to add.
6209
- *
6210
- * @example example.com
6278
+ * @example update
6211
6279
  */
6212
- name: string;
6280
+ op?: string;
6213
6281
  /**
6214
- * Whether the domain has the Vercel Edge Network enabled or not.
6282
+ * Specifies whether domain should be renewed.
6283
+ */
6284
+ renew?: boolean;
6285
+ /**
6286
+ * The custom nameservers for this project.
6215
6287
  *
6216
- * @example true
6288
+ * @maxItems 4
6289
+ * @minItems 0
6290
+ * @uniqueItems true
6291
+ */
6292
+ customNameservers?: string[];
6293
+ /**
6294
+ * Specifies whether this is a DNS zone that intends to use Vercel's nameservers.
6217
6295
  */
6218
- cdnEnabled?: boolean;
6219
6296
  zone?: boolean;
6297
+ } | {
6220
6298
  /**
6221
- * The domain operation to perform.
6222
- *
6223
- * @example add
6299
+ * @example move-out
6224
6300
  */
6225
- method?: string;
6301
+ op?: string;
6302
+ /**
6303
+ * User or team to move domain to
6304
+ */
6305
+ destination?: string;
6226
6306
  };
6227
- queryParams?: CreateOrTransferDomainQueryParams;
6307
+ pathParams?: PatchDomainPathParams;
6308
+ queryParams?: PatchDomainQueryParams;
6228
6309
  } & FetcherExtraProps;
6229
6310
  /**
6230
- * This endpoint is used for registering a new domain name with Vercel for the authenticating user, and also for initiating a domain transfer request from an external Registrar to Vercel.
6311
+ * Update or move apex domain.
6231
6312
  */
6232
- declare const createOrTransferDomain: (variables: CreateOrTransferDomainVariables, signal?: AbortSignal) => Promise<CreateOrTransferDomainResponse>;
6313
+ declare const patchDomain: (variables: PatchDomainVariables, signal?: AbortSignal) => Promise<{
6314
+ moved: boolean;
6315
+ } | {
6316
+ moved: boolean;
6317
+ token: string;
6318
+ } | {
6319
+ renew?: boolean;
6320
+ customNameservers?: string[];
6321
+ zone?: boolean;
6322
+ }>;
6233
6323
  type DeleteDomainPathParams = {
6234
6324
  /**
6235
6325
  * The name of the domain.
@@ -7439,8 +7529,11 @@ type GitNamespacesResponse = {
7439
7529
  provider: string;
7440
7530
  slug: string;
7441
7531
  id: string | number;
7442
- name?: string;
7443
7532
  ownerType: string;
7533
+ name?: string;
7534
+ isAccessRestricted?: boolean;
7535
+ installationId?: number;
7536
+ requireReauth?: boolean;
7444
7537
  }[];
7445
7538
  type GitNamespacesVariables = {
7446
7539
  queryParams?: GitNamespacesQueryParams;
@@ -12705,7 +12798,7 @@ type CreateWebhookResponse = {
12705
12798
  *
12706
12799
  * @example deployment.created
12707
12800
  */
12708
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12801
+ events: ('budget.reached' | 'domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12709
12802
  /**
12710
12803
  * The webhook id
12711
12804
  *
@@ -12752,7 +12845,7 @@ type CreateWebhookRequestBody = {
12752
12845
  /**
12753
12846
  * @minItems 1
12754
12847
  */
12755
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12848
+ events: ('budget.reached' | 'domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12756
12849
  /**
12757
12850
  * @minItems 1
12758
12851
  * @maxItems 50
@@ -12796,7 +12889,7 @@ declare const getWebhooks: (variables: GetWebhooksVariables, signal?: AbortSigna
12796
12889
  *
12797
12890
  * @example deployment.created
12798
12891
  */
12799
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12892
+ events: ('budget.reached' | 'domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12800
12893
  /**
12801
12894
  * The webhook id
12802
12895
  *
@@ -12839,7 +12932,7 @@ declare const getWebhooks: (variables: GetWebhooksVariables, signal?: AbortSigna
12839
12932
  *
12840
12933
  * @example deployment.created
12841
12934
  */
12842
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12935
+ events: ('budget.reached' | 'domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12843
12936
  /**
12844
12937
  * The webhook id
12845
12938
  *
@@ -12893,7 +12986,7 @@ type GetWebhookResponse = {
12893
12986
  *
12894
12987
  * @example deployment.created
12895
12988
  */
12896
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12989
+ events: ('budget.reached' | 'domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
12897
12990
  /**
12898
12991
  * The webhook id
12899
12992
  *
@@ -15417,10 +15510,21 @@ declare const operationsByTag: {
15417
15510
  buyDomain: (variables: BuyDomainVariables, signal?: AbortSignal) => Promise<BuyDomainResponse>;
15418
15511
  checkDomainPrice: (variables: CheckDomainPriceVariables, signal?: AbortSignal) => Promise<CheckDomainPriceResponse>;
15419
15512
  checkDomainStatus: (variables: CheckDomainStatusVariables, signal?: AbortSignal) => Promise<CheckDomainStatusResponse>;
15513
+ getDomainTransfer: (variables: GetDomainTransferVariables, signal?: AbortSignal) => Promise<GetDomainTransferResponse>;
15420
15514
  getDomainConfig: (variables: GetDomainConfigVariables, signal?: AbortSignal) => Promise<GetDomainConfigResponse>;
15421
15515
  getDomain: (variables: GetDomainVariables, signal?: AbortSignal) => Promise<GetDomainResponse>;
15422
15516
  getDomains: (variables: GetDomainsVariables, signal?: AbortSignal) => Promise<GetDomainsResponse>;
15423
15517
  createOrTransferDomain: (variables: CreateOrTransferDomainVariables, signal?: AbortSignal) => Promise<CreateOrTransferDomainResponse>;
15518
+ patchDomain: (variables: PatchDomainVariables, signal?: AbortSignal) => Promise<{
15519
+ moved: boolean;
15520
+ } | {
15521
+ moved: boolean;
15522
+ token: string;
15523
+ } | {
15524
+ renew?: boolean;
15525
+ customNameservers?: string[];
15526
+ zone?: boolean;
15527
+ }>;
15424
15528
  deleteDomain: (variables: DeleteDomainVariables, signal?: AbortSignal) => Promise<DeleteDomainResponse>;
15425
15529
  };
15426
15530
  dns: {
@@ -15990,7 +16094,7 @@ declare const operationsByTag: {
15990
16094
  *
15991
16095
  * @example deployment.created
15992
16096
  */
15993
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
16097
+ events: ('budget.reached' | 'domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
15994
16098
  /**
15995
16099
  * The webhook id
15996
16100
  *
@@ -16033,7 +16137,7 @@ declare const operationsByTag: {
16033
16137
  *
16034
16138
  * @example deployment.created
16035
16139
  */
16036
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
16140
+ events: ('budget.reached' | 'domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
16037
16141
  /**
16038
16142
  * The webhook id
16039
16143
  *
@@ -16349,6 +16453,10 @@ type components_GetDomainError = GetDomainError;
16349
16453
  type components_GetDomainPathParams = GetDomainPathParams;
16350
16454
  type components_GetDomainQueryParams = GetDomainQueryParams;
16351
16455
  type components_GetDomainResponse = GetDomainResponse;
16456
+ type components_GetDomainTransferError = GetDomainTransferError;
16457
+ type components_GetDomainTransferQueryParams = GetDomainTransferQueryParams;
16458
+ type components_GetDomainTransferResponse = GetDomainTransferResponse;
16459
+ type components_GetDomainTransferVariables = GetDomainTransferVariables;
16352
16460
  type components_GetDomainVariables = GetDomainVariables;
16353
16461
  type components_GetDomainsError = GetDomainsError;
16354
16462
  type components_GetDomainsQueryParams = GetDomainsQueryParams;
@@ -16481,6 +16589,10 @@ type components_ListUserEventsError = ListUserEventsError;
16481
16589
  type components_ListUserEventsQueryParams = ListUserEventsQueryParams;
16482
16590
  type components_ListUserEventsResponse = ListUserEventsResponse;
16483
16591
  type components_ListUserEventsVariables = ListUserEventsVariables;
16592
+ type components_PatchDomainError = PatchDomainError;
16593
+ type components_PatchDomainPathParams = PatchDomainPathParams;
16594
+ type components_PatchDomainQueryParams = PatchDomainQueryParams;
16595
+ type components_PatchDomainVariables = PatchDomainVariables;
16484
16596
  type components_PatchTeamError = PatchTeamError;
16485
16597
  type components_PatchTeamPathParams = PatchTeamPathParams;
16486
16598
  type components_PatchTeamRequestBody = PatchTeamRequestBody;
@@ -16662,6 +16774,7 @@ declare const components_getDeploymentFileContents: typeof getDeploymentFileCont
16662
16774
  declare const components_getDeployments: typeof getDeployments;
16663
16775
  declare const components_getDomain: typeof getDomain;
16664
16776
  declare const components_getDomainConfig: typeof getDomainConfig;
16777
+ declare const components_getDomainTransfer: typeof getDomainTransfer;
16665
16778
  declare const components_getDomains: typeof getDomains;
16666
16779
  declare const components_getEdgeConfig: typeof getEdgeConfig;
16667
16780
  declare const components_getEdgeConfigItem: typeof getEdgeConfigItem;
@@ -16694,6 +16807,7 @@ declare const components_listDeploymentAliases: typeof listDeploymentAliases;
16694
16807
  declare const components_listDeploymentFiles: typeof listDeploymentFiles;
16695
16808
  declare const components_listUserEvents: typeof listUserEvents;
16696
16809
  declare const components_operationsByTag: typeof operationsByTag;
16810
+ declare const components_patchDomain: typeof patchDomain;
16697
16811
  declare const components_patchTeam: typeof patchTeam;
16698
16812
  declare const components_patchtEdgeConfigItems: typeof patchtEdgeConfigItems;
16699
16813
  declare const components_recordEvents: typeof recordEvents;
@@ -16975,6 +17089,10 @@ declare namespace components {
16975
17089
  components_GetDomainPathParams as GetDomainPathParams,
16976
17090
  components_GetDomainQueryParams as GetDomainQueryParams,
16977
17091
  components_GetDomainResponse as GetDomainResponse,
17092
+ components_GetDomainTransferError as GetDomainTransferError,
17093
+ components_GetDomainTransferQueryParams as GetDomainTransferQueryParams,
17094
+ components_GetDomainTransferResponse as GetDomainTransferResponse,
17095
+ components_GetDomainTransferVariables as GetDomainTransferVariables,
16978
17096
  components_GetDomainVariables as GetDomainVariables,
16979
17097
  components_GetDomainsError as GetDomainsError,
16980
17098
  components_GetDomainsQueryParams as GetDomainsQueryParams,
@@ -17107,6 +17225,10 @@ declare namespace components {
17107
17225
  components_ListUserEventsQueryParams as ListUserEventsQueryParams,
17108
17226
  components_ListUserEventsResponse as ListUserEventsResponse,
17109
17227
  components_ListUserEventsVariables as ListUserEventsVariables,
17228
+ components_PatchDomainError as PatchDomainError,
17229
+ components_PatchDomainPathParams as PatchDomainPathParams,
17230
+ components_PatchDomainQueryParams as PatchDomainQueryParams,
17231
+ components_PatchDomainVariables as PatchDomainVariables,
17110
17232
  components_PatchTeamError as PatchTeamError,
17111
17233
  components_PatchTeamPathParams as PatchTeamPathParams,
17112
17234
  components_PatchTeamRequestBody as PatchTeamRequestBody,
@@ -17288,6 +17410,7 @@ declare namespace components {
17288
17410
  components_getDeployments as getDeployments,
17289
17411
  components_getDomain as getDomain,
17290
17412
  components_getDomainConfig as getDomainConfig,
17413
+ components_getDomainTransfer as getDomainTransfer,
17291
17414
  components_getDomains as getDomains,
17292
17415
  components_getEdgeConfig as getEdgeConfig,
17293
17416
  components_getEdgeConfigItem as getEdgeConfigItem,
@@ -17320,6 +17443,7 @@ declare namespace components {
17320
17443
  components_listDeploymentFiles as listDeploymentFiles,
17321
17444
  components_listUserEvents as listUserEvents,
17322
17445
  components_operationsByTag as operationsByTag,
17446
+ components_patchDomain as patchDomain,
17323
17447
  components_patchTeam as patchTeam,
17324
17448
  components_patchtEdgeConfigItems as patchtEdgeConfigItems,
17325
17449
  components_recordEvents as recordEvents,
@@ -17757,10 +17881,21 @@ declare const operationsByPath: {
17757
17881
  'PATCH /v1/domains/records/{recordId}': (variables: UpdateRecordVariables, signal?: AbortSignal | undefined) => Promise<UpdateRecordResponse>;
17758
17882
  'DELETE /v2/domains/{domain}/records/{recordId}': (variables: RemoveRecordVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any>>;
17759
17883
  'GET /v4/domains/status': (variables: CheckDomainStatusVariables, signal?: AbortSignal | undefined) => Promise<CheckDomainStatusResponse>;
17884
+ 'GET /v1/domains/{domain}/registry': (variables: GetDomainTransferVariables, signal?: AbortSignal | undefined) => Promise<GetDomainTransferResponse>;
17760
17885
  'GET /v6/domains/{domain}/config': (variables: GetDomainConfigVariables, signal?: AbortSignal | undefined) => Promise<GetDomainConfigResponse>;
17761
17886
  'GET /v5/domains/{domain}': (variables: GetDomainVariables, signal?: AbortSignal | undefined) => Promise<GetDomainResponse>;
17762
17887
  'GET /v5/domains': (variables: GetDomainsVariables, signal?: AbortSignal | undefined) => Promise<GetDomainsResponse>;
17763
17888
  'POST /v5/domains': (variables: CreateOrTransferDomainVariables, signal?: AbortSignal | undefined) => Promise<CreateOrTransferDomainResponse>;
17889
+ 'PATCH /v3/domains/{domain}': (variables: PatchDomainVariables, signal?: AbortSignal | undefined) => Promise<{
17890
+ moved: boolean;
17891
+ } | {
17892
+ moved: boolean;
17893
+ token: string;
17894
+ } | {
17895
+ renew?: boolean;
17896
+ customNameservers?: string[];
17897
+ zone?: boolean;
17898
+ }>;
17764
17899
  'DELETE /v6/domains/{domain}': (variables: DeleteDomainVariables, signal?: AbortSignal | undefined) => Promise<DeleteDomainResponse>;
17765
17900
  'GET /v1/edge-config': (variables: GetEdgeConfigsVariables, signal?: AbortSignal | undefined) => Promise<GetEdgeConfigsResponse>;
17766
17901
  'POST /v1/edge-config': (variables: CreateEdgeConfigVariables, signal?: AbortSignal | undefined) => Promise<CreateEdgeConfigResponse>;
@@ -18293,7 +18428,7 @@ declare const operationsByPath: {
18293
18428
  framework?: "blitzjs" | "nextjs" | "gatsby" | "remix" | "astro" | "hexo" | "eleventy" | "docusaurus-2" | "docusaurus" | "preact" | "solidstart" | "dojo" | "ember" | "vue" | "scully" | "ionic-angular" | "angular" | "polymer" | "svelte" | "sveltekit" | "sveltekit-1" | "ionic-react" | "create-react-app" | "gridsome" | "umijs" | "sapper" | "saber" | "stencil" | "nuxtjs" | "redwoodjs" | "hugo" | "jekyll" | "brunch" | "middleman" | "zola" | "hydrogen" | "vite" | "vitepress" | "vuepress" | "parcel" | "sanity" | "storybook" | null;
18294
18429
  latestDeployment?: string;
18295
18430
  }[] | null;
18296
- events: ("deployment" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
18431
+ events: ("deployment" | "budget.reached" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
18297
18432
  id: string;
18298
18433
  url: string;
18299
18434
  ownerId: string;
@@ -18301,7 +18436,7 @@ declare const operationsByPath: {
18301
18436
  updatedAt: number;
18302
18437
  projectIds?: string[];
18303
18438
  }[] | {
18304
- events: ("deployment" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
18439
+ events: ("deployment" | "budget.reached" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
18305
18440
  id: string;
18306
18441
  url: string;
18307
18442
  ownerId: string;
@@ -18762,10 +18897,21 @@ declare class VercelApi {
18762
18897
  'PATCH /v1/domains/records/{recordId}': (variables: UpdateRecordVariables, signal?: AbortSignal | undefined) => Promise<UpdateRecordResponse>;
18763
18898
  'DELETE /v2/domains/{domain}/records/{recordId}': (variables: RemoveRecordVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any>>;
18764
18899
  'GET /v4/domains/status': (variables: CheckDomainStatusVariables, signal?: AbortSignal | undefined) => Promise<CheckDomainStatusResponse>;
18900
+ 'GET /v1/domains/{domain}/registry': (variables: GetDomainTransferVariables, signal?: AbortSignal | undefined) => Promise<GetDomainTransferResponse>;
18765
18901
  'GET /v6/domains/{domain}/config': (variables: GetDomainConfigVariables, signal?: AbortSignal | undefined) => Promise<GetDomainConfigResponse>;
18766
18902
  'GET /v5/domains/{domain}': (variables: GetDomainVariables, signal?: AbortSignal | undefined) => Promise<GetDomainResponse>;
18767
18903
  'GET /v5/domains': (variables: GetDomainsVariables, signal?: AbortSignal | undefined) => Promise<GetDomainsResponse>;
18768
18904
  'POST /v5/domains': (variables: CreateOrTransferDomainVariables, signal?: AbortSignal | undefined) => Promise<CreateOrTransferDomainResponse>;
18905
+ 'PATCH /v3/domains/{domain}': (variables: PatchDomainVariables, signal?: AbortSignal | undefined) => Promise<{
18906
+ moved: boolean;
18907
+ } | {
18908
+ moved: boolean;
18909
+ token: string;
18910
+ } | {
18911
+ renew?: boolean;
18912
+ customNameservers?: string[];
18913
+ zone?: boolean;
18914
+ }>;
18769
18915
  'DELETE /v6/domains/{domain}': (variables: DeleteDomainVariables, signal?: AbortSignal | undefined) => Promise<DeleteDomainResponse>;
18770
18916
  'GET /v1/edge-config': (variables: GetEdgeConfigsVariables, signal?: AbortSignal | undefined) => Promise<GetEdgeConfigsResponse>;
18771
18917
  'POST /v1/edge-config': (variables: CreateEdgeConfigVariables, signal?: AbortSignal | undefined) => Promise<CreateEdgeConfigResponse>;
@@ -19298,7 +19444,7 @@ declare class VercelApi {
19298
19444
  framework?: "blitzjs" | "nextjs" | "gatsby" | "remix" | "astro" | "hexo" | "eleventy" | "docusaurus-2" | "docusaurus" | "preact" | "solidstart" | "dojo" | "ember" | "vue" | "scully" | "ionic-angular" | "angular" | "polymer" | "svelte" | "sveltekit" | "sveltekit-1" | "ionic-react" | "create-react-app" | "gridsome" | "umijs" | "sapper" | "saber" | "stencil" | "nuxtjs" | "redwoodjs" | "hugo" | "jekyll" | "brunch" | "middleman" | "zola" | "hydrogen" | "vite" | "vitepress" | "vuepress" | "parcel" | "sanity" | "storybook" | null;
19299
19445
  latestDeployment?: string;
19300
19446
  }[] | null;
19301
- events: ("deployment" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
19447
+ events: ("deployment" | "budget.reached" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
19302
19448
  id: string;
19303
19449
  url: string;
19304
19450
  ownerId: string;
@@ -19306,7 +19452,7 @@ declare class VercelApi {
19306
19452
  updatedAt: number;
19307
19453
  projectIds?: string[];
19308
19454
  }[] | {
19309
- events: ("deployment" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
19455
+ events: ("deployment" | "budget.reached" | "domain.created" | "deployment.created" | "deployment.error" | "deployment.canceled" | "deployment.succeeded" | "deployment.ready" | "deployment.check-rerequested" | "integration-configuration.permission-upgraded" | "integration-configuration.removed" | "integration-configuration.scope-change-confirmed" | "project.created" | "project.removed" | "deployment-checks-completed" | "deployment-ready" | "deployment-prepared" | "deployment-error" | "deployment-check-rerequested" | "deployment-canceled" | "project-created" | "project-removed" | "domain-created" | "integration-configuration-permission-updated" | "integration-configuration-removed" | "integration-configuration-scope-change-confirmed")[];
19310
19456
  id: string;
19311
19457
  url: string;
19312
19458
  ownerId: string;
package/dist/index.mjs CHANGED
@@ -243,6 +243,15 @@ const checkDomainStatus = (variables, signal) => fetch$1({
243
243
  ...variables,
244
244
  signal
245
245
  });
246
+ /**
247
+ * Fetch domain transfer availability or transfer status if a transfer is in progress.
248
+ */
249
+ const getDomainTransfer = (variables, signal) => fetch$1({
250
+ url: '/v1/domains/{domain}/registry',
251
+ method: 'get',
252
+ ...variables,
253
+ signal
254
+ });
246
255
  /**
247
256
  * Get a Domain's configuration.
248
257
  */
@@ -266,9 +275,13 @@ const getDomains = (variables, signal) => fetch$1({
266
275
  signal
267
276
  });
268
277
  /**
269
- * This endpoint is used for registering a new domain name with Vercel for the authenticating user, and also for initiating a domain transfer request from an external Registrar to Vercel.
278
+ * This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Can also be used for initiating a domain transfer request from an external Registrar to Vercel.
270
279
  */
271
280
  const createOrTransferDomain = (variables, signal) => fetch$1({ url: '/v5/domains', method: 'post', ...variables, signal });
281
+ /**
282
+ * Update or move apex domain.
283
+ */
284
+ const patchDomain = (variables, signal) => fetch$1({ url: '/v3/domains/{domain}', method: 'patch', ...variables, signal });
272
285
  /**
273
286
  * Delete a previously registered domain name from Vercel. Deleting a domain will automatically remove any associated aliases.
274
287
  */
@@ -880,10 +893,12 @@ const operationsByTag = {
880
893
  buyDomain,
881
894
  checkDomainPrice,
882
895
  checkDomainStatus,
896
+ getDomainTransfer,
883
897
  getDomainConfig,
884
898
  getDomain,
885
899
  getDomains,
886
900
  createOrTransferDomain,
901
+ patchDomain,
887
902
  deleteDomain
888
903
  },
889
904
  dns: { getRecords, createRecord, updateRecord, removeRecord },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vercel-api-js",
3
- "version": "0.1.20",
3
+ "version": "0.1.21",
4
4
  "description": "Vercel API client for Node.js",
5
5
  "author": "SferaDev",
6
6
  "license": "ISC",