@opusdns/api 1.87.0 → 1.88.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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^1.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.87.0",
6
+ "version": "1.88.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -71,6 +71,7 @@ import type {
71
71
  OrganizationCredentialStatus,
72
72
  OrganizationSortField,
73
73
  OrganizationStatus,
74
+ OutboundTransferAction,
74
75
  ParkingSortField,
75
76
  PatchOp,
76
77
  PeriodUnit,
@@ -1309,6 +1310,16 @@ export const ORGANIZATION_STATUS_VALUES = [
1309
1310
  'inactive',
1310
1311
  ] as const satisfies ReadonlyArray<OrganizationStatus>;
1311
1312
 
1313
+ export const OUTBOUND_TRANSFER_ACTION = {
1314
+ APPROVE: "approve",
1315
+ REJECT: "reject",
1316
+ } as const satisfies Record<string, OutboundTransferAction>;
1317
+
1318
+ export const OUTBOUND_TRANSFER_ACTION_VALUES = [
1319
+ 'approve',
1320
+ 'reject',
1321
+ ] as const satisfies ReadonlyArray<OutboundTransferAction>;
1322
+
1312
1323
  export const PARKING_SORT_FIELD = {
1313
1324
  DOMAIN: "domain",
1314
1325
  CREATED_ON: "created_on",
@@ -304,6 +304,8 @@ import type {
304
304
  OrganizationToken,
305
305
  OrganizationUpdate,
306
306
  OrganizationWithBillingData,
307
+ OutboundTransferRequest,
308
+ OutboundTransfer,
307
309
  PageResponse_EmailForwardLog,
308
310
  PageResponse_JobBatchMetadata,
309
311
  PageResponse_Job,
@@ -4281,6 +4283,22 @@ export const KEYS_ORGANIZATION_WITH_BILLING_DATA = [
4281
4283
  KEY_ORGANIZATION_WITH_BILLING_DATA_USERS,
4282
4284
  ] as const satisfies (keyof OrganizationWithBillingData)[];
4283
4285
 
4286
+ export const KEY_OUTBOUND_TRANSFER_REQUEST_ACTION = 'action' satisfies keyof OutboundTransferRequest;
4287
+
4288
+ export const KEYS_OUTBOUND_TRANSFER_REQUEST = [
4289
+ KEY_OUTBOUND_TRANSFER_REQUEST_ACTION,
4290
+ ] as const satisfies (keyof OutboundTransferRequest)[];
4291
+
4292
+ export const KEY_OUTBOUND_TRANSFER_ACTION = 'action' satisfies keyof OutboundTransfer;
4293
+ export const KEY_OUTBOUND_TRANSFER_DOMAIN_ID = 'domain_id' satisfies keyof OutboundTransfer;
4294
+ export const KEY_OUTBOUND_TRANSFER_DOMAIN_NAME = 'domain_name' satisfies keyof OutboundTransfer;
4295
+
4296
+ export const KEYS_OUTBOUND_TRANSFER = [
4297
+ KEY_OUTBOUND_TRANSFER_ACTION,
4298
+ KEY_OUTBOUND_TRANSFER_DOMAIN_ID,
4299
+ KEY_OUTBOUND_TRANSFER_DOMAIN_NAME,
4300
+ ] as const satisfies (keyof OutboundTransfer)[];
4301
+
4284
4302
  export const KEY_PAGE_RESPONSE_EMAIL_FORWARD_LOG_PAGINATION = 'pagination' satisfies keyof PageResponse_EmailForwardLog;
4285
4303
  export const KEY_PAGE_RESPONSE_EMAIL_FORWARD_LOG_RESULTS = 'results' satisfies keyof PageResponse_EmailForwardLog;
4286
4304
 
@@ -44,6 +44,7 @@ import type {
44
44
  OrganizationAttributeUpdate,
45
45
  OrganizationCreate,
46
46
  OrganizationUpdate,
47
+ OutboundTransferRequest,
47
48
  ParkingSignupRequest,
48
49
  PreviewMailReq,
49
50
  PublicAuthRequestForm,
@@ -554,6 +555,13 @@ export type DELETE_DomainsByDomainReferenceTransfer_Request = {
554
555
  };
555
556
  export type DELETE_DomainsByDomainReferenceTransfer_Request_Path = DELETE_DomainsByDomainReferenceTransfer_Request['parameters']['path'];
556
557
 
558
+ export type POST_DomainsByDomainReferenceTransferOutbound_Request = {
559
+ parameters: operations['resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post']['parameters'];
560
+ requestBody: OutboundTransferRequest;
561
+ };
562
+ export type POST_DomainsByDomainReferenceTransferOutbound_Request_Path = POST_DomainsByDomainReferenceTransferOutbound_Request['parameters']['path'];
563
+ export type POST_DomainsByDomainReferenceTransferOutbound_Request_Body = POST_DomainsByDomainReferenceTransferOutbound_Request['requestBody'];
564
+
557
565
  export type GET_DomainsCheck_Request = {
558
566
  parameters: operations['epp_check_domain_v1_domains_check_get']['parameters'];
559
567
  };
@@ -64,6 +64,7 @@ import type {
64
64
  OrganizationAttribute2,
65
65
  OrganizationCredential,
66
66
  OrganizationWithBillingData,
67
+ OutboundTransfer,
67
68
  PageResponse_EmailForwardLog,
68
69
  PageResponse_Job,
69
70
  PageResponse_JobBatchMetadata,
@@ -1148,6 +1149,13 @@ export type POST_DomainsByDomainReferenceRestore_Response = POST_DomainsByDomain
1148
1149
  export type POST_DomainsByDomainReferenceRestore_Response_200 = DomainRestore;
1149
1150
  export type POST_DomainsByDomainReferenceRestore_Response_422 = HTTPValidationError;
1150
1151
 
1152
+ export type POST_DomainsByDomainReferenceTransferOutbound_Response = POST_DomainsByDomainReferenceTransferOutbound_Response_200 | POST_DomainsByDomainReferenceTransferOutbound_Response_400 | POST_DomainsByDomainReferenceTransferOutbound_Response_404 | POST_DomainsByDomainReferenceTransferOutbound_Response_422;
1153
+
1154
+ export type POST_DomainsByDomainReferenceTransferOutbound_Response_200 = OutboundTransfer;
1155
+ export type POST_DomainsByDomainReferenceTransferOutbound_Response_400 = Problem;
1156
+ export type POST_DomainsByDomainReferenceTransferOutbound_Response_404 = Problem;
1157
+ export type POST_DomainsByDomainReferenceTransferOutbound_Response_422 = Problem;
1158
+
1151
1159
  export type POST_DomainsClaimsNotices_Response = POST_DomainsClaimsNotices_Response_200 | POST_DomainsClaimsNotices_Response_404 | POST_DomainsClaimsNotices_Response_422 | POST_DomainsClaimsNotices_Response_503;
1152
1160
 
1153
1161
  export type POST_DomainsClaimsNotices_Response_200 = ClaimsNotices;
@@ -382,6 +382,9 @@ export type OrganizationStatus = components['schemas']['OrganizationStatus'];
382
382
  export type OrganizationToken = components['schemas']['OrganizationTokenResponse'];
383
383
  export type OrganizationUpdate = components['schemas']['OrganizationUpdate'];
384
384
  export type OrganizationWithBillingData = components['schemas']['OrganizationWithBillingData'];
385
+ export type OutboundTransferAction = components['schemas']['OutboundTransferAction'];
386
+ export type OutboundTransferRequest = components['schemas']['OutboundTransferRequest'];
387
+ export type OutboundTransfer = components['schemas']['OutboundTransferResponse'];
385
388
  export type PageResponse_EmailForwardLog = components['schemas']['PageResponse_EmailForwardLog_'];
386
389
  export type PageResponse_JobBatchMetadata = components['schemas']['PageResponse_JobBatchMetadataResponse_'];
387
390
  export type PageResponse_Job = components['schemas']['PageResponse_JobResponse_'];
package/src/openapi.yaml CHANGED
@@ -10270,6 +10270,45 @@ components:
10270
10270
  - name
10271
10271
  title: OrganizationWithBillingData
10272
10272
  type: object
10273
+ OutboundTransferAction:
10274
+ enum:
10275
+ - approve
10276
+ - reject
10277
+ title: OutboundTransferAction
10278
+ type: string
10279
+ OutboundTransferRequest:
10280
+ properties:
10281
+ action:
10282
+ $ref: '#/components/schemas/OutboundTransferAction'
10283
+ description: Whether to approve or reject the pending outbound transfer
10284
+ required:
10285
+ - action
10286
+ title: OutboundTransferRequest
10287
+ type: object
10288
+ OutboundTransferResponse:
10289
+ properties:
10290
+ action:
10291
+ $ref: '#/components/schemas/OutboundTransferAction'
10292
+ description: The action that was applied to the outbound transfer
10293
+ domain_id:
10294
+ description: The ID of the domain whose outbound transfer was resolved
10295
+ examples:
10296
+ - domain_01h45ytscbebyvny4gc8cr8ma2
10297
+ format: typeid
10298
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
10299
+ title: Domain Id
10300
+ type: string
10301
+ x-typeid-prefix: domain
10302
+ domain_name:
10303
+ description: The name of the domain whose outbound transfer was resolved
10304
+ title: Domain Name
10305
+ type: string
10306
+ required:
10307
+ - domain_id
10308
+ - domain_name
10309
+ - action
10310
+ title: OutboundTransferResponse
10311
+ type: object
10273
10312
  PageResponse_EmailForwardLog_:
10274
10313
  properties:
10275
10314
  pagination:
@@ -14895,7 +14934,7 @@ info:
14895
14934
  \n\n"
14896
14935
  summary: OpusDNS - your gateway to a seamless domain management experience.
14897
14936
  title: OpusDNS API
14898
- version: 2026-07-29-014404
14937
+ version: 2026-07-29-143904
14899
14938
  x-logo:
14900
14939
  altText: OpusDNS API Reference
14901
14940
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -24611,6 +24650,85 @@ paths:
24611
24650
  - domain
24612
24651
  x-required-permissions:
24613
24652
  - domains:manage
24653
+ /v1/domains/{domain_reference}/transfer/outbound:
24654
+ post:
24655
+ operationId: resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post
24656
+ parameters:
24657
+ - in: path
24658
+ name: domain_reference
24659
+ required: true
24660
+ schema:
24661
+ anyOf:
24662
+ - examples:
24663
+ - domain_01h45ytscbebyvny4gc8cr8ma2
24664
+ format: typeid
24665
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
24666
+ type: string
24667
+ x-typeid-prefix: domain
24668
+ - type: string
24669
+ title: Domain Reference
24670
+ - $ref: '#/components/parameters/DatetimeFormatHeader'
24671
+ requestBody:
24672
+ content:
24673
+ application/json:
24674
+ schema:
24675
+ $ref: '#/components/schemas/OutboundTransferRequest'
24676
+ required: true
24677
+ responses:
24678
+ '200':
24679
+ content:
24680
+ application/json:
24681
+ schema:
24682
+ $ref: '#/components/schemas/OutboundTransferResponse'
24683
+ description: Successful Response
24684
+ '400':
24685
+ content:
24686
+ application/problem+json:
24687
+ example:
24688
+ code: ERROR_DOMAIN_TRANSFER
24689
+ detail: There was an error transferring the domain
24690
+ domain_name: Additional error context.
24691
+ reason: An unspecified error occurred
24692
+ status: 400
24693
+ title: Domain Transfer Error
24694
+ type: domain-transfer
24695
+ schema:
24696
+ $ref: '#/components/schemas/Problem'
24697
+ description: Bad Request
24698
+ '404':
24699
+ content:
24700
+ application/problem+json:
24701
+ example:
24702
+ code: ERROR_DOMAIN_NOT_FOUND
24703
+ detail: Domain not found
24704
+ domain_name: Additional error context.
24705
+ status: 404
24706
+ title: Domain Management Error
24707
+ type: domain-not-found
24708
+ schema:
24709
+ $ref: '#/components/schemas/Problem'
24710
+ description: Not Found
24711
+ '422':
24712
+ content:
24713
+ application/problem+json:
24714
+ example:
24715
+ code: ERROR_REGISTRY_POLICY
24716
+ detail: The registry rejected the request due to a policy violation
24717
+ domain_name: Additional error context.
24718
+ status: 422
24719
+ title: Registry Policy Error
24720
+ type: domain-registry-policy
24721
+ schema:
24722
+ $ref: '#/components/schemas/Problem'
24723
+ description: Unprocessable Content
24724
+ security:
24725
+ - OAuth2PasswordBearer: []
24726
+ - APIKeyHeader: []
24727
+ summary: Approve or reject an outbound domain transfer
24728
+ tags:
24729
+ - domain
24730
+ x-required-permissions:
24731
+ - domains:manage
24614
24732
  /v1/email-forwards:
24615
24733
  get:
24616
24734
  description: Retrieves a paginated list of all email forwards for the organization.
package/src/schema.d.ts CHANGED
@@ -1501,6 +1501,23 @@ export interface paths {
1501
1501
  patch?: never;
1502
1502
  trace?: never;
1503
1503
  };
1504
+ "/v1/domains/{domain_reference}/transfer/outbound": {
1505
+ parameters: {
1506
+ query?: never;
1507
+ header?: never;
1508
+ path?: never;
1509
+ cookie?: never;
1510
+ };
1511
+ get?: never;
1512
+ put?: never;
1513
+ /** Approve or reject an outbound domain transfer */
1514
+ post: operations["resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post"];
1515
+ delete?: never;
1516
+ options?: never;
1517
+ head?: never;
1518
+ patch?: never;
1519
+ trace?: never;
1520
+ };
1504
1521
  "/v1/email-forwards": {
1505
1522
  parameters: {
1506
1523
  query?: never;
@@ -9722,6 +9739,33 @@ export interface components {
9722
9739
  /** Users */
9723
9740
  users?: components["schemas"]["User"][];
9724
9741
  };
9742
+ /**
9743
+ * OutboundTransferAction
9744
+ * @enum {string}
9745
+ */
9746
+ OutboundTransferAction: "approve" | "reject";
9747
+ /** OutboundTransferRequest */
9748
+ OutboundTransferRequest: {
9749
+ /** @description Whether to approve or reject the pending outbound transfer */
9750
+ action: components["schemas"]["OutboundTransferAction"];
9751
+ };
9752
+ /** OutboundTransferResponse */
9753
+ OutboundTransferResponse: {
9754
+ /** @description The action that was applied to the outbound transfer */
9755
+ action: components["schemas"]["OutboundTransferAction"];
9756
+ /**
9757
+ * Domain Id
9758
+ * Format: typeid
9759
+ * @description The ID of the domain whose outbound transfer was resolved
9760
+ * @example domain_01h45ytscbebyvny4gc8cr8ma2
9761
+ */
9762
+ domain_id: TypeId<"domain">;
9763
+ /**
9764
+ * Domain Name
9765
+ * @description The name of the domain whose outbound transfer was resolved
9766
+ */
9767
+ domain_name: string;
9768
+ };
9725
9769
  /** PageResponse[EmailForwardLog] */
9726
9770
  PageResponse_EmailForwardLog_: {
9727
9771
  pagination: components["schemas"]["PaginationMetadata"];
@@ -20341,6 +20385,90 @@ export interface operations {
20341
20385
  };
20342
20386
  };
20343
20387
  };
20388
+ resolve_outbound_transfer_v1_domains__domain_reference__transfer_outbound_post: {
20389
+ parameters: {
20390
+ query?: never;
20391
+ header?: {
20392
+ /**
20393
+ * @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
20394
+ * @example rfc3339
20395
+ */
20396
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
20397
+ };
20398
+ path: {
20399
+ domain_reference: TypeId<"domain"> | string;
20400
+ };
20401
+ cookie?: never;
20402
+ };
20403
+ requestBody: {
20404
+ content: {
20405
+ "application/json": components["schemas"]["OutboundTransferRequest"];
20406
+ };
20407
+ };
20408
+ responses: {
20409
+ /** @description Successful Response */
20410
+ 200: {
20411
+ headers: {
20412
+ [name: string]: unknown;
20413
+ };
20414
+ content: {
20415
+ "application/json": components["schemas"]["OutboundTransferResponse"];
20416
+ };
20417
+ };
20418
+ /** @description Bad Request */
20419
+ 400: {
20420
+ headers: {
20421
+ [name: string]: unknown;
20422
+ };
20423
+ content: {
20424
+ /** @example {
20425
+ * "code": "ERROR_DOMAIN_TRANSFER",
20426
+ * "detail": "There was an error transferring the domain",
20427
+ * "domain_name": "Additional error context.",
20428
+ * "reason": "An unspecified error occurred",
20429
+ * "status": 400,
20430
+ * "title": "Domain Transfer Error",
20431
+ * "type": "domain-transfer"
20432
+ * } */
20433
+ "application/problem+json": components["schemas"]["Problem"];
20434
+ };
20435
+ };
20436
+ /** @description Not Found */
20437
+ 404: {
20438
+ headers: {
20439
+ [name: string]: unknown;
20440
+ };
20441
+ content: {
20442
+ /** @example {
20443
+ * "code": "ERROR_DOMAIN_NOT_FOUND",
20444
+ * "detail": "Domain not found",
20445
+ * "domain_name": "Additional error context.",
20446
+ * "status": 404,
20447
+ * "title": "Domain Management Error",
20448
+ * "type": "domain-not-found"
20449
+ * } */
20450
+ "application/problem+json": components["schemas"]["Problem"];
20451
+ };
20452
+ };
20453
+ /** @description Unprocessable Content */
20454
+ 422: {
20455
+ headers: {
20456
+ [name: string]: unknown;
20457
+ };
20458
+ content: {
20459
+ /** @example {
20460
+ * "code": "ERROR_REGISTRY_POLICY",
20461
+ * "detail": "The registry rejected the request due to a policy violation",
20462
+ * "domain_name": "Additional error context.",
20463
+ * "status": 422,
20464
+ * "title": "Registry Policy Error",
20465
+ * "type": "domain-registry-policy"
20466
+ * } */
20467
+ "application/problem+json": components["schemas"]["Problem"];
20468
+ };
20469
+ };
20470
+ };
20471
+ };
20344
20472
  list_email_forwards_v1_email_forwards_get: {
20345
20473
  parameters: {
20346
20474
  query?: {