@opusdns/api 0.205.0 → 0.207.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": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.205.0",
6
+ "version": "0.207.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -3551,7 +3551,7 @@ export type POST_EmailForwards_Request_Body = POST_EmailForwards_Request['reques
3551
3551
  * Request type for DELETE EmailForwardsEmailForwardId endpoint
3552
3552
  *
3553
3553
  * Delete email forward configuration
3554
- * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
3554
+ * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from the email forwarding provider).
3555
3555
  *
3556
3556
  * @remarks
3557
3557
  * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardId endpoint.
@@ -3590,7 +3590,7 @@ export type DELETE_EmailForwardsEmailForwardId_Request_Path = DELETE_EmailForwar
3590
3590
  * Request type for GET EmailForwardsEmailForwardId endpoint
3591
3591
  *
3592
3592
  * Get email forward configuration
3593
- * Retrieves the email forward configuration for the specified zone including all aliases
3593
+ * Retrieves the email forward configuration for the specified email forward including all aliases
3594
3594
  *
3595
3595
  * @remarks
3596
3596
  * This type defines the complete request structure for the GET EmailForwardsEmailForwardId endpoint.
@@ -3629,7 +3629,7 @@ export type GET_EmailForwardsEmailForwardId_Request_Path = GET_EmailForwardsEmai
3629
3629
  * Request type for POST EmailForwardsEmailForwardIdAliases endpoint
3630
3630
  *
3631
3631
  * Create email forward alias
3632
- * Creates a new email forward alias for the specified hostname.
3632
+ * Creates a new email forward alias for the specified email forward. Use '*' as the alias name to configure a catch-all alias that forwards all unmatched emails for the domain.
3633
3633
  *
3634
3634
  * @remarks
3635
3635
  * This type defines the complete request structure for the POST EmailForwardsEmailForwardIdAliases endpoint.
@@ -3682,7 +3682,7 @@ export type POST_EmailForwardsEmailForwardIdAliases_Request_Body = POST_EmailFor
3682
3682
  * Request type for DELETE EmailForwardsEmailForwardIdAliasesAliasId endpoint
3683
3683
  *
3684
3684
  * Delete email forward alias
3685
- * Deletes a specific email forward alias for the specified zone
3685
+ * Deletes a specific email forward alias specified by email_forward_alias_id for the specified email forward
3686
3686
  *
3687
3687
  * @remarks
3688
3688
  * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardIdAliasesAliasId endpoint.
@@ -3721,7 +3721,7 @@ export type DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request_Path = DELE
3721
3721
  * Request type for PUT EmailForwardsEmailForwardIdAliasesAliasId endpoint
3722
3722
  *
3723
3723
  * Update email forward alias
3724
- * Updates the forward_to address for a specific email forward alias
3724
+ * Updates the forward_to address for a specific email forward alias specified by email_forward_alias_id
3725
3725
  *
3726
3726
  * @remarks
3727
3727
  * This type defines the complete request structure for the PUT EmailForwardsEmailForwardIdAliasesAliasId endpoint.
@@ -3774,7 +3774,7 @@ export type PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request_Body = PUT_Ema
3774
3774
  * Request type for PATCH EmailForwardsEmailForwardIdDisable endpoint
3775
3775
  *
3776
3776
  * Disable email forwarding
3777
- * Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forward provider. The email forward configuration is preserved but disabled.
3777
+ * Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forwarding provider. The email forward configuration is preserved but disabled.
3778
3778
  *
3779
3779
  * @remarks
3780
3780
  * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardIdDisable endpoint.
@@ -3813,7 +3813,7 @@ export type PATCH_EmailForwardsEmailForwardIdDisable_Request_Path = PATCH_EmailF
3813
3813
  * Request type for PATCH EmailForwardsEmailForwardIdEnable endpoint
3814
3814
  *
3815
3815
  * Enable email forwarding
3816
- * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
3816
+ * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forwarding provider.
3817
3817
  *
3818
3818
  * @remarks
3819
3819
  * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardIdEnable endpoint.
@@ -6482,7 +6482,7 @@ export type POST_EmailForwards_Response_422 = HTTPValidationError
6482
6482
  * Response types for DELETE EmailForwardsByEmailForwardId endpoint
6483
6483
  *
6484
6484
  * Delete email forward configuration
6485
- * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
6485
+ * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from the email forwarding provider).
6486
6486
  *
6487
6487
  * @remarks
6488
6488
  * This type defines all possible response structures for the DELETE EmailForwardsByEmailForwardId endpoint.
@@ -6556,7 +6556,7 @@ export type DELETE_EmailForwardsByEmailForwardId_Response_422 = HTTPValidationEr
6556
6556
  * Response types for GET EmailForwardsByEmailForwardId endpoint
6557
6557
  *
6558
6558
  * Get email forward configuration
6559
- * Retrieves the email forward configuration for the specified zone including all aliases
6559
+ * Retrieves the email forward configuration for the specified email forward including all aliases
6560
6560
  *
6561
6561
  * @remarks
6562
6562
  * This type defines all possible response structures for the GET EmailForwardsByEmailForwardId endpoint.
@@ -6666,7 +6666,7 @@ export type GET_EmailForwardsByEmailForwardId_Response_422 = HTTPValidationError
6666
6666
  * Response types for POST EmailForwardsByEmailForwardIdAliases endpoint
6667
6667
  *
6668
6668
  * Create email forward alias
6669
- * Creates a new email forward alias for the specified hostname.
6669
+ * Creates a new email forward alias for the specified email forward. Use '*' as the alias name to configure a catch-all alias that forwards all unmatched emails for the domain.
6670
6670
  *
6671
6671
  * @remarks
6672
6672
  * This type defines all possible response structures for the POST EmailForwardsByEmailForwardIdAliases endpoint.
@@ -6794,7 +6794,7 @@ export type POST_EmailForwardsByEmailForwardIdAliases_Response_422 = HTTPValidat
6794
6794
  * Response types for DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
6795
6795
  *
6796
6796
  * Delete email forward alias
6797
- * Deletes a specific email forward alias for the specified zone
6797
+ * Deletes a specific email forward alias specified by email_forward_alias_id for the specified email forward
6798
6798
  *
6799
6799
  * @remarks
6800
6800
  * This type defines all possible response structures for the DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
@@ -6886,7 +6886,7 @@ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 =
6886
6886
  * Response types for PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
6887
6887
  *
6888
6888
  * Update email forward alias
6889
- * Updates the forward_to address for a specific email forward alias
6889
+ * Updates the forward_to address for a specific email forward alias specified by email_forward_alias_id
6890
6890
  *
6891
6891
  * @remarks
6892
6892
  * This type defines all possible response structures for the PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
@@ -6996,7 +6996,7 @@ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTT
6996
6996
  * Response types for PATCH EmailForwardsByEmailForwardIdDisable endpoint
6997
6997
  *
6998
6998
  * Disable email forwarding
6999
- * Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forward provider. The email forward configuration is preserved but disabled.
6999
+ * Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forwarding provider. The email forward configuration is preserved but disabled.
7000
7000
  *
7001
7001
  * @remarks
7002
7002
  * This type defines all possible response structures for the PATCH EmailForwardsByEmailForwardIdDisable endpoint.
@@ -7088,7 +7088,7 @@ export type PATCH_EmailForwardsByEmailForwardIdDisable_Response_422 = HTTPValida
7088
7088
  * Response types for PATCH EmailForwardsByEmailForwardIdEnable endpoint
7089
7089
  *
7090
7090
  * Enable email forwarding
7091
- * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
7091
+ * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forwarding provider.
7092
7092
  *
7093
7093
  * @remarks
7094
7094
  * This type defines all possible response structures for the PATCH EmailForwardsByEmailForwardIdEnable endpoint.
package/src/openapi.yaml CHANGED
@@ -7350,7 +7350,7 @@ info:
7350
7350
  '
7351
7351
  summary: OpusDNS - your gateway to a seamless domain management experience.
7352
7352
  title: OpusDNS API
7353
- version: 2026-02-25-184018
7353
+ version: 2026-02-26-130702
7354
7354
  x-logo:
7355
7355
  altText: OpusDNS API Reference
7356
7356
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -13454,6 +13454,32 @@ paths:
13454
13454
  requestBody:
13455
13455
  content:
13456
13456
  application/json:
13457
+ examples:
13458
+ catch_all:
13459
+ description: Use '*' as alias to forward all unmatched emails for
13460
+ the hostname.
13461
+ summary: Catch-all email forwarding
13462
+ value:
13463
+ aliases:
13464
+ - alias: '*'
13465
+ forward_to:
13466
+ - inbox@example.net
13467
+ enabled: true
13468
+ hostname: example.com.
13469
+ email_forward:
13470
+ description: Create email forwarding with named aliases for a hostname.
13471
+ summary: Standard email forwarding setup
13472
+ value:
13473
+ aliases:
13474
+ - alias: sales
13475
+ forward_to:
13476
+ - sales-team@example.net
13477
+ - alias: support
13478
+ forward_to:
13479
+ - support@example.net
13480
+ - oncall@example.net
13481
+ enabled: false
13482
+ hostname: mail.example.com.
13457
13483
  schema:
13458
13484
  $ref: '#/components/schemas/EmailForwardCreate'
13459
13485
  required: true
@@ -13461,9 +13487,45 @@ paths:
13461
13487
  '201':
13462
13488
  content:
13463
13489
  application/json:
13490
+ examples:
13491
+ catch_all_email_forwarding_response:
13492
+ description: Response when creating email forwarding with a catch-all
13493
+ alias.
13494
+ summary: Response for catch-all email forwarding setup
13495
+ value:
13496
+ aliases:
13497
+ - alias: '*'
13498
+ email_forward_alias_id: email_forward_alias_01jx0000000000000000000003
13499
+ forward_to:
13500
+ - inbox@example.net
13501
+ created_on: '2025-11-14T09:01:38'
13502
+ email_forward_id: email_forward_01jx0000000000000000000002
13503
+ enabled: true
13504
+ hostname: example.com.
13505
+ updated_on: '2025-11-14T09:01:38'
13506
+ standard_email_forwarding_response:
13507
+ description: Response when creating email forwarding with named
13508
+ aliases.
13509
+ summary: Response for standard email forwarding setup
13510
+ value:
13511
+ aliases:
13512
+ - alias: sales
13513
+ email_forward_alias_id: email_forward_alias_01jx0000000000000000000001
13514
+ forward_to:
13515
+ - sales-team@example.net
13516
+ - alias: support
13517
+ email_forward_alias_id: email_forward_alias_01jx0000000000000000000002
13518
+ forward_to:
13519
+ - support@example.net
13520
+ - oncall@example.net
13521
+ created_on: '2025-11-14T09:01:38'
13522
+ email_forward_id: email_forward_01jx0000000000000000000001
13523
+ enabled: false
13524
+ hostname: mail.example.com.
13525
+ updated_on: '2025-11-14T09:01:38'
13464
13526
  schema:
13465
13527
  $ref: '#/components/schemas/EmailForwardResponse'
13466
- description: Successful Response
13528
+ description: Email forwarding created successfully
13467
13529
  '401':
13468
13530
  content:
13469
13531
  application/problem+json:
@@ -13492,27 +13554,27 @@ paths:
13492
13554
  content:
13493
13555
  application/problem+json:
13494
13556
  example:
13495
- code: ERROR_EMAIL_FORWARD_NOT_FOUND
13496
- detail: 'Email forward not found for hostname: Additional error context.'
13557
+ code: ERROR_ZONE_NOT_FOUND
13558
+ detail: Zone not found
13497
13559
  status: 404
13498
- title: Email Forward Error
13499
- type: email-forward-not-found
13560
+ title: DNS Error
13561
+ type: dns-zone-not-found
13562
+ zone_name: Zone example.com. not found
13500
13563
  schema:
13501
13564
  $ref: '#/components/schemas/Problem'
13502
- description: Not Found
13565
+ description: DNS zone was not found
13503
13566
  '409':
13504
13567
  content:
13505
13568
  application/problem+json:
13506
13569
  example:
13507
13570
  code: ERROR_EMAIL_FORWARD_ALREADY_EXISTS
13508
- detail: 'Email forward already exists for hostname: Additional error
13509
- context.'
13571
+ detail: 'Email forward already exists for hostname: mail.example.com'
13510
13572
  status: 409
13511
13573
  title: Email Forward Error
13512
13574
  type: email-forward-already-exists
13513
13575
  schema:
13514
13576
  $ref: '#/components/schemas/Problem'
13515
- description: Conflict
13577
+ description: Email forwarding configuration already exists
13516
13578
  '422':
13517
13579
  content:
13518
13580
  application/problem+json:
@@ -13529,7 +13591,7 @@ paths:
13529
13591
  delete:
13530
13592
  description: Permanently deletes the email forward configuration including all
13531
13593
  aliases. If enabled, automatically disables first (removes DNS records and
13532
- unregisters from ImprovMX).
13594
+ unregisters from the email forwarding provider).
13533
13595
  operationId: delete_email_forward_v1_email_forwards__email_forward_id__delete
13534
13596
  parameters:
13535
13597
  - in: path
@@ -13583,8 +13645,8 @@ paths:
13583
13645
  tags:
13584
13646
  - email_forward
13585
13647
  get:
13586
- description: Retrieves the email forward configuration for the specified zone
13587
- including all aliases
13648
+ description: Retrieves the email forward configuration for the specified email
13649
+ forward including all aliases
13588
13650
  operationId: get_email_forward_v1_email_forwards__email_forward_id__get
13589
13651
  parameters:
13590
13652
  - in: path
@@ -13655,7 +13717,9 @@ paths:
13655
13717
  - email_forward
13656
13718
  /v1/email-forwards/{email_forward_id}/aliases:
13657
13719
  post:
13658
- description: Creates a new email forward alias for the specified hostname.
13720
+ description: Creates a new email forward alias for the specified email forward.
13721
+ Use '*' as the alias name to configure a catch-all alias that forwards all
13722
+ unmatched emails for the domain.
13659
13723
  operationId: create_email_forward_alias_v1_email_forwards__email_forward_id__aliases_post
13660
13724
  parameters:
13661
13725
  - in: path
@@ -13672,6 +13736,22 @@ paths:
13672
13736
  requestBody:
13673
13737
  content:
13674
13738
  application/json:
13739
+ examples:
13740
+ catch_all_alias:
13741
+ description: Use '*' to configure a catch-all alias.
13742
+ summary: Catch-all alias
13743
+ value:
13744
+ alias: '*'
13745
+ forward_to:
13746
+ - catchall@example.net
13747
+ named_alias:
13748
+ description: Create a regular alias for email forwarding.
13749
+ summary: Named alias
13750
+ value:
13751
+ alias: support
13752
+ forward_to:
13753
+ - support@example.net
13754
+ - oncall@example.net
13675
13755
  schema:
13676
13756
  $ref: '#/components/schemas/EmailForwardAliasCreate'
13677
13757
  required: true
@@ -13679,9 +13759,27 @@ paths:
13679
13759
  '201':
13680
13760
  content:
13681
13761
  application/json:
13762
+ examples:
13763
+ catch_all_alias_response:
13764
+ description: Response when creating a catch-all alias.
13765
+ summary: Response for catch-all alias
13766
+ value:
13767
+ alias: '*'
13768
+ email_forward_alias_id: email_forward_alias_01jx0000000000000000000005
13769
+ forward_to:
13770
+ - catchall@example.net
13771
+ named_alias_response:
13772
+ description: Response when creating a regular alias.
13773
+ summary: Response for named alias
13774
+ value:
13775
+ alias: support
13776
+ email_forward_alias_id: email_forward_alias_01jx0000000000000000000004
13777
+ forward_to:
13778
+ - support@example.net
13779
+ - oncall@example.net
13682
13780
  schema:
13683
13781
  $ref: '#/components/schemas/EmailForwardAlias'
13684
- description: Successful Response
13782
+ description: Email forwarding alias created successfully
13685
13783
  '401':
13686
13784
  content:
13687
13785
  application/problem+json:
@@ -13711,25 +13809,25 @@ paths:
13711
13809
  application/problem+json:
13712
13810
  example:
13713
13811
  code: ERROR_EMAIL_FORWARD_NOT_FOUND
13714
- detail: 'Email forward not found for hostname: Additional error context.'
13812
+ detail: 'Email forward not found for ID: email_forward_01jx0000000000000000000009'
13715
13813
  status: 404
13716
13814
  title: Email Forward Error
13717
13815
  type: email-forward-not-found
13718
13816
  schema:
13719
13817
  $ref: '#/components/schemas/Problem'
13720
- description: Not Found
13818
+ description: Email forwarding configuration was not found
13721
13819
  '409':
13722
13820
  content:
13723
13821
  application/problem+json:
13724
13822
  example:
13725
13823
  code: ERROR_EMAIL_FORWARD_ALIAS_ALREADY_EXISTS
13726
- detail: Additional error context.
13824
+ detail: Alias already exists
13727
13825
  status: 409
13728
13826
  title: Email Forward Error
13729
13827
  type: email-forward-alias-already-exists
13730
13828
  schema:
13731
13829
  $ref: '#/components/schemas/Problem'
13732
- description: Conflict
13830
+ description: Email forwarding alias already exists
13733
13831
  '422':
13734
13832
  content:
13735
13833
  application/problem+json:
@@ -13744,7 +13842,8 @@ paths:
13744
13842
  - email_forward
13745
13843
  /v1/email-forwards/{email_forward_id}/aliases/{alias_id}:
13746
13844
  delete:
13747
- description: Deletes a specific email forward alias for the specified zone
13845
+ description: Deletes a specific email forward alias specified by email_forward_alias_id
13846
+ for the specified email forward
13748
13847
  operationId: delete_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__delete
13749
13848
  parameters:
13750
13849
  - in: path
@@ -13800,11 +13899,12 @@ paths:
13800
13899
  content:
13801
13900
  application/problem+json:
13802
13901
  example:
13803
- code: ERROR_EMAIL_FORWARD_NOT_FOUND
13804
- detail: 'Email forward not found for hostname: Additional error context.'
13902
+ code: ERROR_EMAIL_FORWARD_ALIAS_NOT_FOUND
13903
+ detail: Alias could not be found
13904
+ email_forward_id: Additional error context.
13805
13905
  status: 404
13806
13906
  title: Email Forward Error
13807
- type: email-forward-not-found
13907
+ type: email-forward-alias-not-found
13808
13908
  schema:
13809
13909
  $ref: '#/components/schemas/Problem'
13810
13910
  description: Not Found
@@ -13822,6 +13922,7 @@ paths:
13822
13922
  - email_forward
13823
13923
  put:
13824
13924
  description: Updates the forward_to address for a specific email forward alias
13925
+ specified by email_forward_alias_id
13825
13926
  operationId: update_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__put
13826
13927
  parameters:
13827
13928
  - in: path
@@ -13887,11 +13988,12 @@ paths:
13887
13988
  content:
13888
13989
  application/problem+json:
13889
13990
  example:
13890
- code: ERROR_EMAIL_FORWARD_NOT_FOUND
13891
- detail: 'Email forward not found for hostname: Additional error context.'
13991
+ code: ERROR_EMAIL_FORWARD_ALIAS_NOT_FOUND
13992
+ detail: Alias could not be found
13993
+ email_forward_id: Additional error context.
13892
13994
  status: 404
13893
13995
  title: Email Forward Error
13894
- type: email-forward-not-found
13996
+ type: email-forward-alias-not-found
13895
13997
  schema:
13896
13998
  $ref: '#/components/schemas/Problem'
13897
13999
  description: Not Found
@@ -13910,7 +14012,7 @@ paths:
13910
14012
  /v1/email-forwards/{email_forward_id}/disable:
13911
14013
  patch:
13912
14014
  description: Disables email forwarding by removing MX and SPF DNS records and
13913
- unregistering the domain from the email forward provider. The email forward
14015
+ unregistering the domain from the email forwarding provider. The email forward
13914
14016
  configuration is preserved but disabled.
13915
14017
  operationId: disable_email_forward_v1_email_forwards__email_forward_id__disable_patch
13916
14018
  parameters:
@@ -13979,7 +14081,7 @@ paths:
13979
14081
  /v1/email-forwards/{email_forward_id}/enable:
13980
14082
  patch:
13981
14083
  description: Enables email forwarding by creating necessary MX and SPF DNS records
13982
- and registering the domain with the email forward provider.
14084
+ and registering the domain with the email forwarding provider.
13983
14085
  operationId: enable_email_forward_v1_email_forwards__email_forward_id__enable_patch
13984
14086
  parameters:
13985
14087
  - in: path
package/src/schema.d.ts CHANGED
@@ -1150,14 +1150,14 @@ export interface paths {
1150
1150
  };
1151
1151
  /**
1152
1152
  * Get email forward configuration
1153
- * @description Retrieves the email forward configuration for the specified zone including all aliases
1153
+ * @description Retrieves the email forward configuration for the specified email forward including all aliases
1154
1154
  */
1155
1155
  get: operations["get_email_forward_v1_email_forwards__email_forward_id__get"];
1156
1156
  put?: never;
1157
1157
  post?: never;
1158
1158
  /**
1159
1159
  * Delete email forward configuration
1160
- * @description Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
1160
+ * @description Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from the email forwarding provider).
1161
1161
  */
1162
1162
  delete: operations["delete_email_forward_v1_email_forwards__email_forward_id__delete"];
1163
1163
  options?: never;
@@ -1176,7 +1176,7 @@ export interface paths {
1176
1176
  put?: never;
1177
1177
  /**
1178
1178
  * Create email forward alias
1179
- * @description Creates a new email forward alias for the specified hostname.
1179
+ * @description Creates a new email forward alias for the specified email forward. Use '*' as the alias name to configure a catch-all alias that forwards all unmatched emails for the domain.
1180
1180
  */
1181
1181
  post: operations["create_email_forward_alias_v1_email_forwards__email_forward_id__aliases_post"];
1182
1182
  delete?: never;
@@ -1195,13 +1195,13 @@ export interface paths {
1195
1195
  get?: never;
1196
1196
  /**
1197
1197
  * Update email forward alias
1198
- * @description Updates the forward_to address for a specific email forward alias
1198
+ * @description Updates the forward_to address for a specific email forward alias specified by email_forward_alias_id
1199
1199
  */
1200
1200
  put: operations["update_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__put"];
1201
1201
  post?: never;
1202
1202
  /**
1203
1203
  * Delete email forward alias
1204
- * @description Deletes a specific email forward alias for the specified zone
1204
+ * @description Deletes a specific email forward alias specified by email_forward_alias_id for the specified email forward
1205
1205
  */
1206
1206
  delete: operations["delete_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__delete"];
1207
1207
  options?: never;
@@ -1224,7 +1224,7 @@ export interface paths {
1224
1224
  head?: never;
1225
1225
  /**
1226
1226
  * Disable email forwarding
1227
- * @description Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forward provider. The email forward configuration is preserved but disabled.
1227
+ * @description Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forwarding provider. The email forward configuration is preserved but disabled.
1228
1228
  */
1229
1229
  patch: operations["disable_email_forward_v1_email_forwards__email_forward_id__disable_patch"];
1230
1230
  trace?: never;
@@ -1244,7 +1244,7 @@ export interface paths {
1244
1244
  head?: never;
1245
1245
  /**
1246
1246
  * Enable email forwarding
1247
- * @description Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
1247
+ * @description Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forwarding provider.
1248
1248
  */
1249
1249
  patch: operations["enable_email_forward_v1_email_forwards__email_forward_id__enable_patch"];
1250
1250
  trace?: never;
@@ -11330,7 +11330,7 @@ export interface operations {
11330
11330
  };
11331
11331
  };
11332
11332
  responses: {
11333
- /** @description Successful Response */
11333
+ /** @description Email forwarding created successfully */
11334
11334
  201: {
11335
11335
  headers: {
11336
11336
  [name: string]: unknown;
@@ -11371,23 +11371,24 @@ export interface operations {
11371
11371
  "application/problem+json": components["schemas"]["Problem"];
11372
11372
  };
11373
11373
  };
11374
- /** @description Not Found */
11374
+ /** @description DNS zone was not found */
11375
11375
  404: {
11376
11376
  headers: {
11377
11377
  [name: string]: unknown;
11378
11378
  };
11379
11379
  content: {
11380
11380
  /** @example {
11381
- * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11382
- * "detail": "Email forward not found for hostname: Additional error context.",
11381
+ * "code": "ERROR_ZONE_NOT_FOUND",
11382
+ * "detail": "Zone not found",
11383
11383
  * "status": 404,
11384
- * "title": "Email Forward Error",
11385
- * "type": "email-forward-not-found"
11384
+ * "title": "DNS Error",
11385
+ * "type": "dns-zone-not-found",
11386
+ * "zone_name": "Zone example.com. not found"
11386
11387
  * } */
11387
11388
  "application/problem+json": components["schemas"]["Problem"];
11388
11389
  };
11389
11390
  };
11390
- /** @description Conflict */
11391
+ /** @description Email forwarding configuration already exists */
11391
11392
  409: {
11392
11393
  headers: {
11393
11394
  [name: string]: unknown;
@@ -11395,7 +11396,7 @@ export interface operations {
11395
11396
  content: {
11396
11397
  /** @example {
11397
11398
  * "code": "ERROR_EMAIL_FORWARD_ALREADY_EXISTS",
11398
- * "detail": "Email forward already exists for hostname: Additional error context.",
11399
+ * "detail": "Email forward already exists for hostname: mail.example.com",
11399
11400
  * "status": 409,
11400
11401
  * "title": "Email Forward Error",
11401
11402
  * "type": "email-forward-already-exists"
@@ -11569,7 +11570,7 @@ export interface operations {
11569
11570
  };
11570
11571
  };
11571
11572
  responses: {
11572
- /** @description Successful Response */
11573
+ /** @description Email forwarding alias created successfully */
11573
11574
  201: {
11574
11575
  headers: {
11575
11576
  [name: string]: unknown;
@@ -11610,7 +11611,7 @@ export interface operations {
11610
11611
  "application/problem+json": components["schemas"]["Problem"];
11611
11612
  };
11612
11613
  };
11613
- /** @description Not Found */
11614
+ /** @description Email forwarding configuration was not found */
11614
11615
  404: {
11615
11616
  headers: {
11616
11617
  [name: string]: unknown;
@@ -11618,7 +11619,7 @@ export interface operations {
11618
11619
  content: {
11619
11620
  /** @example {
11620
11621
  * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11621
- * "detail": "Email forward not found for hostname: Additional error context.",
11622
+ * "detail": "Email forward not found for ID: email_forward_01jx0000000000000000000009",
11622
11623
  * "status": 404,
11623
11624
  * "title": "Email Forward Error",
11624
11625
  * "type": "email-forward-not-found"
@@ -11626,7 +11627,7 @@ export interface operations {
11626
11627
  "application/problem+json": components["schemas"]["Problem"];
11627
11628
  };
11628
11629
  };
11629
- /** @description Conflict */
11630
+ /** @description Email forwarding alias already exists */
11630
11631
  409: {
11631
11632
  headers: {
11632
11633
  [name: string]: unknown;
@@ -11634,7 +11635,7 @@ export interface operations {
11634
11635
  content: {
11635
11636
  /** @example {
11636
11637
  * "code": "ERROR_EMAIL_FORWARD_ALIAS_ALREADY_EXISTS",
11637
- * "detail": "Additional error context.",
11638
+ * "detail": "Alias already exists",
11638
11639
  * "status": 409,
11639
11640
  * "title": "Email Forward Error",
11640
11641
  * "type": "email-forward-alias-already-exists"
@@ -11717,11 +11718,12 @@ export interface operations {
11717
11718
  };
11718
11719
  content: {
11719
11720
  /** @example {
11720
- * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11721
- * "detail": "Email forward not found for hostname: Additional error context.",
11721
+ * "code": "ERROR_EMAIL_FORWARD_ALIAS_NOT_FOUND",
11722
+ * "detail": "Alias could not be found",
11723
+ * "email_forward_id": "Additional error context.",
11722
11724
  * "status": 404,
11723
11725
  * "title": "Email Forward Error",
11724
- * "type": "email-forward-not-found"
11726
+ * "type": "email-forward-alias-not-found"
11725
11727
  * } */
11726
11728
  "application/problem+json": components["schemas"]["Problem"];
11727
11729
  };
@@ -11795,11 +11797,12 @@ export interface operations {
11795
11797
  };
11796
11798
  content: {
11797
11799
  /** @example {
11798
- * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11799
- * "detail": "Email forward not found for hostname: Additional error context.",
11800
+ * "code": "ERROR_EMAIL_FORWARD_ALIAS_NOT_FOUND",
11801
+ * "detail": "Alias could not be found",
11802
+ * "email_forward_id": "Additional error context.",
11800
11803
  * "status": 404,
11801
11804
  * "title": "Email Forward Error",
11802
- * "type": "email-forward-not-found"
11805
+ * "type": "email-forward-alias-not-found"
11803
11806
  * } */
11804
11807
  "application/problem+json": components["schemas"]["Problem"];
11805
11808
  };