@opusdns/api 0.112.0 → 0.114.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/src/schema.d.ts CHANGED
@@ -258,6 +258,26 @@ export interface paths {
258
258
  patch?: never;
259
259
  trace?: never;
260
260
  };
261
+ "/v1/dns/email-forwards": {
262
+ parameters: {
263
+ query?: never;
264
+ header?: never;
265
+ path?: never;
266
+ cookie?: never;
267
+ };
268
+ /**
269
+ * List email forwards by zone
270
+ * @description Retrieves a paginated list of email forwards grouped by DNS zones.
271
+ */
272
+ get: operations["list_email_forwards_by_zone_v1_dns_email_forwards_get"];
273
+ put?: never;
274
+ post?: never;
275
+ delete?: never;
276
+ options?: never;
277
+ head?: never;
278
+ patch?: never;
279
+ trace?: never;
280
+ };
261
281
  "/v1/dns/summary": {
262
282
  parameters: {
263
283
  query?: never;
@@ -347,6 +367,26 @@ export interface paths {
347
367
  patch?: never;
348
368
  trace?: never;
349
369
  };
370
+ "/v1/dns/{zone_name}/email-forwards": {
371
+ parameters: {
372
+ query?: never;
373
+ header?: never;
374
+ path?: never;
375
+ cookie?: never;
376
+ };
377
+ /**
378
+ * List email forwards for a zone
379
+ * @description Retrieves all email forwards configured for the specified DNS zone, including subdomains and all aliases.
380
+ */
381
+ get: operations["list_zone_email_forwards_v1_dns__zone_name__email_forwards_get"];
382
+ put?: never;
383
+ post?: never;
384
+ delete?: never;
385
+ options?: never;
386
+ head?: never;
387
+ patch?: never;
388
+ trace?: never;
389
+ };
350
390
  "/v1/dns/{zone_name}/records": {
351
391
  parameters: {
352
392
  query?: never;
@@ -811,45 +851,99 @@ export interface paths {
811
851
  patch?: never;
812
852
  trace?: never;
813
853
  };
814
- "/v1/email-forwards/{zone_name}/aliases": {
854
+ "/v1/email-forwards": {
855
+ parameters: {
856
+ query?: never;
857
+ header?: never;
858
+ path?: never;
859
+ cookie?: never;
860
+ };
861
+ /**
862
+ * List all email forwards
863
+ * @description Retrieves a paginated list of all email forwards for the organization.
864
+ */
865
+ get: operations["list_email_forwards_v1_email_forwards_get"];
866
+ put?: never;
867
+ /**
868
+ * Create email forward configuration
869
+ * @description Creates an email forward configuration with optional aliases. Can be created enabled or disabled (default: disabled). Includes created_on and updated_on timestamps.
870
+ */
871
+ post: operations["create_email_forward_v1_email_forwards_post"];
872
+ delete?: never;
873
+ options?: never;
874
+ head?: never;
875
+ patch?: never;
876
+ trace?: never;
877
+ };
878
+ "/v1/email-forwards/{email_forward_id}": {
879
+ parameters: {
880
+ query?: never;
881
+ header?: never;
882
+ path?: never;
883
+ cookie?: never;
884
+ };
885
+ /**
886
+ * Get email forward configuration
887
+ * @description Retrieves the email forward configuration for the specified zone including all aliases
888
+ */
889
+ get: operations["get_email_forward_v1_email_forwards__email_forward_id__get"];
890
+ put?: never;
891
+ post?: never;
892
+ /**
893
+ * Delete email forward configuration
894
+ * @description Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
895
+ */
896
+ delete: operations["delete_email_forward_v1_email_forwards__email_forward_id__delete"];
897
+ options?: never;
898
+ head?: never;
899
+ patch?: never;
900
+ trace?: never;
901
+ };
902
+ "/v1/email-forwards/{email_forward_id}/aliases": {
815
903
  parameters: {
816
904
  query?: never;
817
905
  header?: never;
818
906
  path?: never;
819
907
  cookie?: never;
820
908
  };
821
- /** Get Email Forward Aliases */
822
- get: operations["get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get"];
909
+ get?: never;
823
910
  put?: never;
824
- /** Create Email Forward Alias */
825
- post: operations["create_email_forward_alias_v1_email_forwards__zone_name__aliases_post"];
826
- /** Delete Email Forward Aliases */
827
- delete: operations["delete_email_forward_aliases_v1_email_forwards__zone_name__aliases_delete"];
911
+ /**
912
+ * Create email forward alias
913
+ * @description Creates a new email forward alias for the specified hostname.
914
+ */
915
+ post: operations["create_email_forward_alias_v1_email_forwards__email_forward_id__aliases_post"];
916
+ delete?: never;
828
917
  options?: never;
829
918
  head?: never;
830
919
  patch?: never;
831
920
  trace?: never;
832
921
  };
833
- "/v1/email-forwards/{zone_name}/aliases/{alias}": {
922
+ "/v1/email-forwards/{email_forward_id}/aliases/{alias_id}": {
834
923
  parameters: {
835
924
  query?: never;
836
925
  header?: never;
837
926
  path?: never;
838
927
  cookie?: never;
839
928
  };
840
- /** Get Email Forward Alias */
841
- get: operations["get_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__get"];
842
- /** Update Email Forward Alias */
843
- put: operations["update_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__put"];
929
+ get?: never;
930
+ /**
931
+ * Update email forward alias
932
+ * @description Updates the forward_to address for a specific email forward alias
933
+ */
934
+ put: operations["update_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__put"];
844
935
  post?: never;
845
- /** Delete Email Forward Alias */
846
- delete: operations["delete_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__delete"];
936
+ /**
937
+ * Delete email forward alias
938
+ * @description Deletes a specific email forward alias for the specified zone
939
+ */
940
+ delete: operations["delete_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__delete"];
847
941
  options?: never;
848
942
  head?: never;
849
943
  patch?: never;
850
944
  trace?: never;
851
945
  };
852
- "/v1/email-forwards/{zone_name}/disable": {
946
+ "/v1/email-forwards/{email_forward_id}/disable": {
853
947
  parameters: {
854
948
  query?: never;
855
949
  header?: never;
@@ -862,11 +956,14 @@ export interface paths {
862
956
  delete?: never;
863
957
  options?: never;
864
958
  head?: never;
865
- /** Disable Email Forward */
866
- patch: operations["disable_email_forward_v1_email_forwards__zone_name__disable_patch"];
959
+ /**
960
+ * Disable email forwarding
961
+ * @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.
962
+ */
963
+ patch: operations["disable_email_forward_v1_email_forwards__email_forward_id__disable_patch"];
867
964
  trace?: never;
868
965
  };
869
- "/v1/email-forwards/{zone_name}/enable": {
966
+ "/v1/email-forwards/{email_forward_id}/enable": {
870
967
  parameters: {
871
968
  query?: never;
872
969
  header?: never;
@@ -879,8 +976,11 @@ export interface paths {
879
976
  delete?: never;
880
977
  options?: never;
881
978
  head?: never;
882
- /** Enable Email Forward */
883
- patch: operations["enable_email_forward_v1_email_forwards__zone_name__enable_patch"];
979
+ /**
980
+ * Enable email forwarding
981
+ * @description Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
982
+ */
983
+ patch: operations["enable_email_forward_v1_email_forwards__email_forward_id__enable_patch"];
884
984
  trace?: never;
885
985
  };
886
986
  "/v1/events": {
@@ -3096,6 +3196,22 @@ export interface components {
3096
3196
  };
3097
3197
  /** EmailForwardAlias */
3098
3198
  EmailForwardAlias: {
3199
+ /** Alias */
3200
+ alias: string;
3201
+ /**
3202
+ * Email Forward Alias Id
3203
+ * Format: typeid
3204
+ * @example email_forward_alias_01h45ytscbebyvny4gc8cr8ma2
3205
+ */
3206
+ email_forward_alias_id: TypeId<"email_forward_alias">;
3207
+ /**
3208
+ * Forward To
3209
+ * Format: email
3210
+ */
3211
+ forward_to: string;
3212
+ };
3213
+ /** EmailForwardAliasCreate */
3214
+ EmailForwardAliasCreate: {
3099
3215
  /** Alias */
3100
3216
  alias: string;
3101
3217
  /**
@@ -3112,6 +3228,69 @@ export interface components {
3112
3228
  */
3113
3229
  forward_to: string;
3114
3230
  };
3231
+ /** EmailForwardCreate */
3232
+ EmailForwardCreate: {
3233
+ /**
3234
+ * Aliases
3235
+ * @default []
3236
+ */
3237
+ aliases: components["schemas"]["EmailForwardAliasCreate"][];
3238
+ /**
3239
+ * Enabled
3240
+ * @default false
3241
+ */
3242
+ enabled: boolean;
3243
+ /** Hostname */
3244
+ hostname: string;
3245
+ };
3246
+ /** EmailForwardResponse */
3247
+ EmailForwardResponse: {
3248
+ /** Aliases */
3249
+ aliases: components["schemas"]["EmailForwardAlias"][];
3250
+ /**
3251
+ * Created On
3252
+ * Format: date-time
3253
+ */
3254
+ created_on: Date;
3255
+ /**
3256
+ * Email Forward Id
3257
+ * Format: typeid
3258
+ * @example email_forward_01h45ytscbebyvny4gc8cr8ma2
3259
+ */
3260
+ email_forward_id: TypeId<"email_forward">;
3261
+ /** Enabled */
3262
+ enabled: boolean;
3263
+ /** Hostname */
3264
+ hostname: string;
3265
+ /**
3266
+ * Updated On
3267
+ * Format: date-time
3268
+ */
3269
+ updated_on: Date;
3270
+ };
3271
+ /**
3272
+ * EmailForwardSortField
3273
+ * @enum {string}
3274
+ */
3275
+ EmailForwardSortField: "hostname" | "enabled" | "created_on" | "updated_on";
3276
+ /** EmailForwardZone */
3277
+ EmailForwardZone: {
3278
+ /** Email Forwards */
3279
+ email_forwards: components["schemas"]["EmailForwardResponse"][];
3280
+ /**
3281
+ * Zone Id
3282
+ * Format: typeid
3283
+ * @example zone_01h45ytscbebyvny4gc8cr8ma2
3284
+ */
3285
+ zone_id: TypeId<"zone">;
3286
+ /** Zone Name */
3287
+ zone_name: string;
3288
+ };
3289
+ /**
3290
+ * EmailForwardZoneSortField
3291
+ * @enum {string}
3292
+ */
3293
+ EmailForwardZoneSortField: "name" | "created_on" | "updated_on";
3115
3294
  /**
3116
3295
  * EmailVerificationStatus
3117
3296
  * @enum {string}
@@ -4135,11 +4314,17 @@ export interface components {
4135
4314
  /** Results */
4136
4315
  results: components["schemas"]["DomainResponse"][];
4137
4316
  };
4138
- /** Pagination[EmailForwardAlias] */
4139
- Pagination_EmailForwardAlias_: {
4317
+ /** Pagination[EmailForwardResponse] */
4318
+ Pagination_EmailForwardResponse_: {
4319
+ pagination: components["schemas"]["PaginationMetadata"];
4320
+ /** Results */
4321
+ results: components["schemas"]["EmailForwardResponse"][];
4322
+ };
4323
+ /** Pagination[EmailForwardZone] */
4324
+ Pagination_EmailForwardZone_: {
4140
4325
  pagination: components["schemas"]["PaginationMetadata"];
4141
4326
  /** Results */
4142
- results: components["schemas"]["EmailForwardAlias"][];
4327
+ results: components["schemas"]["EmailForwardZone"][];
4143
4328
  };
4144
4329
  /** Pagination[EventResponse] */
4145
4330
  Pagination_EventResponse_: {
@@ -6273,6 +6458,73 @@ export interface operations {
6273
6458
  };
6274
6459
  };
6275
6460
  };
6461
+ list_email_forwards_by_zone_v1_dns_email_forwards_get: {
6462
+ parameters: {
6463
+ query?: {
6464
+ search?: string | null;
6465
+ sort_by?: components["schemas"]["EmailForwardZoneSortField"];
6466
+ sort_order?: components["schemas"]["SortOrder"];
6467
+ page?: number;
6468
+ page_size?: number;
6469
+ };
6470
+ header?: never;
6471
+ path?: never;
6472
+ cookie?: never;
6473
+ };
6474
+ requestBody?: never;
6475
+ responses: {
6476
+ /** @description Successful Response */
6477
+ 200: {
6478
+ headers: {
6479
+ [name: string]: unknown;
6480
+ };
6481
+ content: {
6482
+ "application/json": components["schemas"]["Pagination_EmailForwardZone_"];
6483
+ };
6484
+ };
6485
+ /** @description Unauthorized */
6486
+ 401: {
6487
+ headers: {
6488
+ [name: string]: unknown;
6489
+ };
6490
+ content: {
6491
+ /** @example {
6492
+ * "code": "ERROR_AUTHENTICATION",
6493
+ * "detail": "Additional error context.",
6494
+ * "status": 401,
6495
+ * "title": "Authentication Error",
6496
+ * "type": "authentication"
6497
+ * } */
6498
+ "application/problem+json": components["schemas"]["Problem"];
6499
+ };
6500
+ };
6501
+ /** @description Forbidden */
6502
+ 403: {
6503
+ headers: {
6504
+ [name: string]: unknown;
6505
+ };
6506
+ content: {
6507
+ /** @example {
6508
+ * "code": "ERROR_PERMISSION_DENIED",
6509
+ * "detail": "Insufficient permissions to perform this action",
6510
+ * "status": 403,
6511
+ * "title": "Permission Denied",
6512
+ * "type": "permission-denied"
6513
+ * } */
6514
+ "application/problem+json": components["schemas"]["Problem"];
6515
+ };
6516
+ };
6517
+ /** @description Validation Error */
6518
+ 422: {
6519
+ headers: {
6520
+ [name: string]: unknown;
6521
+ };
6522
+ content: {
6523
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6524
+ };
6525
+ };
6526
+ };
6527
+ };
6276
6528
  get_zones_summary_v1_dns_summary_get: {
6277
6529
  parameters: {
6278
6530
  query?: never;
@@ -6305,7 +6557,7 @@ export interface operations {
6305
6557
  };
6306
6558
  requestBody?: never;
6307
6559
  responses: {
6308
- /** @description DNS zone retrieved successfully */
6560
+ /** @description Successful Response */
6309
6561
  200: {
6310
6562
  headers: {
6311
6563
  [name: string]: unknown;
@@ -6515,7 +6767,7 @@ export interface operations {
6515
6767
  };
6516
6768
  };
6517
6769
  };
6518
- patch_zone_records_v1_dns__zone_name__records_patch: {
6770
+ list_zone_email_forwards_v1_dns__zone_name__email_forwards_get: {
6519
6771
  parameters: {
6520
6772
  query?: never;
6521
6773
  header?: never;
@@ -6525,31 +6777,45 @@ export interface operations {
6525
6777
  };
6526
6778
  cookie?: never;
6527
6779
  };
6528
- requestBody: {
6529
- content: {
6530
- "application/json": components["schemas"]["DnsZoneRecordsPatchOps"];
6531
- };
6532
- };
6780
+ requestBody?: never;
6533
6781
  responses: {
6534
6782
  /** @description Successful Response */
6535
- 204: {
6783
+ 200: {
6536
6784
  headers: {
6537
6785
  [name: string]: unknown;
6538
6786
  };
6539
- content?: never;
6787
+ content: {
6788
+ "application/json": components["schemas"]["EmailForwardZone"];
6789
+ };
6540
6790
  };
6541
- /** @description Bad Request */
6542
- 400: {
6791
+ /** @description Unauthorized */
6792
+ 401: {
6543
6793
  headers: {
6544
6794
  [name: string]: unknown;
6545
6795
  };
6546
6796
  content: {
6547
6797
  /** @example {
6548
- * "code": "ERROR_DNS",
6798
+ * "code": "ERROR_AUTHENTICATION",
6549
6799
  * "detail": "Additional error context.",
6550
- * "status": 400,
6551
- * "title": "DNS Error",
6552
- * "type": "dns"
6800
+ * "status": 401,
6801
+ * "title": "Authentication Error",
6802
+ * "type": "authentication"
6803
+ * } */
6804
+ "application/problem+json": components["schemas"]["Problem"];
6805
+ };
6806
+ };
6807
+ /** @description Forbidden */
6808
+ 403: {
6809
+ headers: {
6810
+ [name: string]: unknown;
6811
+ };
6812
+ content: {
6813
+ /** @example {
6814
+ * "code": "ERROR_PERMISSION_DENIED",
6815
+ * "detail": "Insufficient permissions to perform this action",
6816
+ * "status": 403,
6817
+ * "title": "Permission Denied",
6818
+ * "type": "permission-denied"
6553
6819
  * } */
6554
6820
  "application/problem+json": components["schemas"]["Problem"];
6555
6821
  };
@@ -6565,7 +6831,7 @@ export interface operations {
6565
6831
  };
6566
6832
  };
6567
6833
  };
6568
- update_zone_rrsets_v1_dns__zone_name__rrsets_put: {
6834
+ patch_zone_records_v1_dns__zone_name__records_patch: {
6569
6835
  parameters: {
6570
6836
  query?: never;
6571
6837
  header?: never;
@@ -6577,7 +6843,7 @@ export interface operations {
6577
6843
  };
6578
6844
  requestBody: {
6579
6845
  content: {
6580
- "application/json": components["schemas"]["DnsZoneRrsetsCreate"];
6846
+ "application/json": components["schemas"]["DnsZoneRecordsPatchOps"];
6581
6847
  };
6582
6848
  };
6583
6849
  responses: {
@@ -6615,7 +6881,7 @@ export interface operations {
6615
6881
  };
6616
6882
  };
6617
6883
  };
6618
- patch_zone_rrsets_v1_dns__zone_name__rrsets_patch: {
6884
+ update_zone_rrsets_v1_dns__zone_name__rrsets_put: {
6619
6885
  parameters: {
6620
6886
  query?: never;
6621
6887
  header?: never;
@@ -6627,7 +6893,7 @@ export interface operations {
6627
6893
  };
6628
6894
  requestBody: {
6629
6895
  content: {
6630
- "application/json": components["schemas"]["DnsZoneRrsetsPatchOps"];
6896
+ "application/json": components["schemas"]["DnsZoneRrsetsCreate"];
6631
6897
  };
6632
6898
  };
6633
6899
  responses: {
@@ -6665,12 +6931,62 @@ export interface operations {
6665
6931
  };
6666
6932
  };
6667
6933
  };
6668
- list_domain_forwards_v1_domain_forwards_get: {
6934
+ patch_zone_rrsets_v1_dns__zone_name__rrsets_patch: {
6669
6935
  parameters: {
6670
- query?: {
6671
- search?: string | null;
6672
- sort_by?: components["schemas"]["DomainForwardSortField"];
6673
- sort_order?: components["schemas"]["SortOrder"];
6936
+ query?: never;
6937
+ header?: never;
6938
+ path: {
6939
+ /** @description DNS zone name (trailing dot optional) */
6940
+ zone_name: string;
6941
+ };
6942
+ cookie?: never;
6943
+ };
6944
+ requestBody: {
6945
+ content: {
6946
+ "application/json": components["schemas"]["DnsZoneRrsetsPatchOps"];
6947
+ };
6948
+ };
6949
+ responses: {
6950
+ /** @description Successful Response */
6951
+ 204: {
6952
+ headers: {
6953
+ [name: string]: unknown;
6954
+ };
6955
+ content?: never;
6956
+ };
6957
+ /** @description Bad Request */
6958
+ 400: {
6959
+ headers: {
6960
+ [name: string]: unknown;
6961
+ };
6962
+ content: {
6963
+ /** @example {
6964
+ * "code": "ERROR_DNS",
6965
+ * "detail": "Additional error context.",
6966
+ * "status": 400,
6967
+ * "title": "DNS Error",
6968
+ * "type": "dns"
6969
+ * } */
6970
+ "application/problem+json": components["schemas"]["Problem"];
6971
+ };
6972
+ };
6973
+ /** @description Validation Error */
6974
+ 422: {
6975
+ headers: {
6976
+ [name: string]: unknown;
6977
+ };
6978
+ content: {
6979
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6980
+ };
6981
+ };
6982
+ };
6983
+ };
6984
+ list_domain_forwards_v1_domain_forwards_get: {
6985
+ parameters: {
6986
+ query?: {
6987
+ search?: string | null;
6988
+ sort_by?: components["schemas"]["DomainForwardSortField"];
6989
+ sort_order?: components["schemas"]["SortOrder"];
6674
6990
  page?: number;
6675
6991
  page_size?: number;
6676
6992
  };
@@ -8589,17 +8905,18 @@ export interface operations {
8589
8905
  };
8590
8906
  };
8591
8907
  };
8592
- get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get: {
8908
+ list_email_forwards_v1_email_forwards_get: {
8593
8909
  parameters: {
8594
8910
  query?: {
8911
+ search?: string | null;
8912
+ enabled?: boolean | null;
8913
+ sort_by?: components["schemas"]["EmailForwardSortField"];
8914
+ sort_order?: components["schemas"]["SortOrder"];
8595
8915
  page?: number;
8596
8916
  page_size?: number;
8597
8917
  };
8598
8918
  header?: never;
8599
- path: {
8600
- /** @description DNS zone name (trailing dot optional) */
8601
- zone_name: string;
8602
- };
8919
+ path?: never;
8603
8920
  cookie?: never;
8604
8921
  };
8605
8922
  requestBody?: never;
@@ -8610,7 +8927,39 @@ export interface operations {
8610
8927
  [name: string]: unknown;
8611
8928
  };
8612
8929
  content: {
8613
- "application/json": components["schemas"]["Pagination_EmailForwardAlias_"];
8930
+ "application/json": components["schemas"]["Pagination_EmailForwardResponse_"];
8931
+ };
8932
+ };
8933
+ /** @description Unauthorized */
8934
+ 401: {
8935
+ headers: {
8936
+ [name: string]: unknown;
8937
+ };
8938
+ content: {
8939
+ /** @example {
8940
+ * "code": "ERROR_AUTHENTICATION",
8941
+ * "detail": "Additional error context.",
8942
+ * "status": 401,
8943
+ * "title": "Authentication Error",
8944
+ * "type": "authentication"
8945
+ * } */
8946
+ "application/problem+json": components["schemas"]["Problem"];
8947
+ };
8948
+ };
8949
+ /** @description Forbidden */
8950
+ 403: {
8951
+ headers: {
8952
+ [name: string]: unknown;
8953
+ };
8954
+ content: {
8955
+ /** @example {
8956
+ * "code": "ERROR_PERMISSION_DENIED",
8957
+ * "detail": "Insufficient permissions to perform this action",
8958
+ * "status": 403,
8959
+ * "title": "Permission Denied",
8960
+ * "type": "permission-denied"
8961
+ * } */
8962
+ "application/problem+json": components["schemas"]["Problem"];
8614
8963
  };
8615
8964
  };
8616
8965
  /** @description Validation Error */
@@ -8624,19 +8973,16 @@ export interface operations {
8624
8973
  };
8625
8974
  };
8626
8975
  };
8627
- create_email_forward_alias_v1_email_forwards__zone_name__aliases_post: {
8976
+ create_email_forward_v1_email_forwards_post: {
8628
8977
  parameters: {
8629
8978
  query?: never;
8630
8979
  header?: never;
8631
- path: {
8632
- /** @description DNS zone name (trailing dot optional) */
8633
- zone_name: string;
8634
- };
8980
+ path?: never;
8635
8981
  cookie?: never;
8636
8982
  };
8637
8983
  requestBody: {
8638
8984
  content: {
8639
- "application/json": components["schemas"]["EmailForwardAlias"];
8985
+ "application/json": components["schemas"]["EmailForwardCreate"];
8640
8986
  };
8641
8987
  };
8642
8988
  responses: {
@@ -8645,37 +8991,73 @@ export interface operations {
8645
8991
  headers: {
8646
8992
  [name: string]: unknown;
8647
8993
  };
8648
- content?: never;
8994
+ content: {
8995
+ "application/json": components["schemas"]["EmailForwardResponse"];
8996
+ };
8649
8997
  };
8650
- /** @description Validation Error */
8651
- 422: {
8998
+ /** @description Unauthorized */
8999
+ 401: {
8652
9000
  headers: {
8653
9001
  [name: string]: unknown;
8654
9002
  };
8655
9003
  content: {
8656
- "application/problem+json": components["schemas"]["HTTPValidationError"];
9004
+ /** @example {
9005
+ * "code": "ERROR_AUTHENTICATION",
9006
+ * "detail": "Additional error context.",
9007
+ * "status": 401,
9008
+ * "title": "Authentication Error",
9009
+ * "type": "authentication"
9010
+ * } */
9011
+ "application/problem+json": components["schemas"]["Problem"];
8657
9012
  };
8658
9013
  };
8659
- };
8660
- };
8661
- delete_email_forward_aliases_v1_email_forwards__zone_name__aliases_delete: {
8662
- parameters: {
8663
- query?: never;
8664
- header?: never;
8665
- path: {
8666
- /** @description DNS zone name (trailing dot optional) */
8667
- zone_name: string;
9014
+ /** @description Forbidden */
9015
+ 403: {
9016
+ headers: {
9017
+ [name: string]: unknown;
9018
+ };
9019
+ content: {
9020
+ /** @example {
9021
+ * "code": "ERROR_PERMISSION_DENIED",
9022
+ * "detail": "Insufficient permissions to perform this action",
9023
+ * "status": 403,
9024
+ * "title": "Permission Denied",
9025
+ * "type": "permission-denied"
9026
+ * } */
9027
+ "application/problem+json": components["schemas"]["Problem"];
9028
+ };
8668
9029
  };
8669
- cookie?: never;
8670
- };
8671
- requestBody?: never;
8672
- responses: {
8673
- /** @description Successful Response */
8674
- 204: {
9030
+ /** @description Not Found */
9031
+ 404: {
8675
9032
  headers: {
8676
9033
  [name: string]: unknown;
8677
9034
  };
8678
- content?: never;
9035
+ content: {
9036
+ /** @example {
9037
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
9038
+ * "detail": "Email forward not found for hostname: Additional error context.",
9039
+ * "status": 404,
9040
+ * "title": "Email Forward Error",
9041
+ * "type": "email-forward-not-found"
9042
+ * } */
9043
+ "application/problem+json": components["schemas"]["Problem"];
9044
+ };
9045
+ };
9046
+ /** @description Conflict */
9047
+ 409: {
9048
+ headers: {
9049
+ [name: string]: unknown;
9050
+ };
9051
+ content: {
9052
+ /** @example {
9053
+ * "code": "ERROR_EMAIL_FORWARD_DOMAIN_ALREADY_ENABLED",
9054
+ * "detail": "Email forward already exists for hostname: Additional error context.",
9055
+ * "status": 409,
9056
+ * "title": "Email Forward Error",
9057
+ * "type": "email-forward-already-exists"
9058
+ * } */
9059
+ "application/problem+json": components["schemas"]["Problem"];
9060
+ };
8679
9061
  };
8680
9062
  /** @description Validation Error */
8681
9063
  422: {
@@ -8688,14 +9070,12 @@ export interface operations {
8688
9070
  };
8689
9071
  };
8690
9072
  };
8691
- get_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__get: {
9073
+ get_email_forward_v1_email_forwards__email_forward_id__get: {
8692
9074
  parameters: {
8693
9075
  query?: never;
8694
9076
  header?: never;
8695
9077
  path: {
8696
- alias: string;
8697
- /** @description DNS zone name (trailing dot optional) */
8698
- zone_name: string;
9078
+ email_forward_id: TypeId<"email_forward">;
8699
9079
  };
8700
9080
  cookie?: never;
8701
9081
  };
@@ -8707,43 +9087,56 @@ export interface operations {
8707
9087
  [name: string]: unknown;
8708
9088
  };
8709
9089
  content: {
8710
- "application/json": components["schemas"]["EmailForwardAlias"];
9090
+ "application/json": components["schemas"]["EmailForwardResponse"];
8711
9091
  };
8712
9092
  };
8713
- /** @description Validation Error */
8714
- 422: {
9093
+ /** @description Unauthorized */
9094
+ 401: {
8715
9095
  headers: {
8716
9096
  [name: string]: unknown;
8717
9097
  };
8718
9098
  content: {
8719
- "application/problem+json": components["schemas"]["HTTPValidationError"];
9099
+ /** @example {
9100
+ * "code": "ERROR_AUTHENTICATION",
9101
+ * "detail": "Additional error context.",
9102
+ * "status": 401,
9103
+ * "title": "Authentication Error",
9104
+ * "type": "authentication"
9105
+ * } */
9106
+ "application/problem+json": components["schemas"]["Problem"];
8720
9107
  };
8721
9108
  };
8722
- };
8723
- };
8724
- update_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__put: {
8725
- parameters: {
8726
- query?: never;
8727
- header?: never;
8728
- path: {
8729
- alias: string;
8730
- /** @description DNS zone name (trailing dot optional) */
8731
- zone_name: string;
8732
- };
8733
- cookie?: never;
8734
- };
8735
- requestBody: {
8736
- content: {
8737
- "application/json": components["schemas"]["EmailForwardAliasUpdate"];
9109
+ /** @description Forbidden */
9110
+ 403: {
9111
+ headers: {
9112
+ [name: string]: unknown;
9113
+ };
9114
+ content: {
9115
+ /** @example {
9116
+ * "code": "ERROR_PERMISSION_DENIED",
9117
+ * "detail": "Insufficient permissions to perform this action",
9118
+ * "status": 403,
9119
+ * "title": "Permission Denied",
9120
+ * "type": "permission-denied"
9121
+ * } */
9122
+ "application/problem+json": components["schemas"]["Problem"];
9123
+ };
8738
9124
  };
8739
- };
8740
- responses: {
8741
- /** @description Successful Response */
8742
- 201: {
9125
+ /** @description Not Found */
9126
+ 404: {
8743
9127
  headers: {
8744
9128
  [name: string]: unknown;
8745
9129
  };
8746
- content?: never;
9130
+ content: {
9131
+ /** @example {
9132
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
9133
+ * "detail": "Email forward not found for hostname: Additional error context.",
9134
+ * "status": 404,
9135
+ * "title": "Email Forward Error",
9136
+ * "type": "email-forward-not-found"
9137
+ * } */
9138
+ "application/problem+json": components["schemas"]["Problem"];
9139
+ };
8747
9140
  };
8748
9141
  /** @description Validation Error */
8749
9142
  422: {
@@ -8756,14 +9149,12 @@ export interface operations {
8756
9149
  };
8757
9150
  };
8758
9151
  };
8759
- delete_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__delete: {
9152
+ delete_email_forward_v1_email_forwards__email_forward_id__delete: {
8760
9153
  parameters: {
8761
9154
  query?: never;
8762
9155
  header?: never;
8763
9156
  path: {
8764
- alias: string;
8765
- /** @description DNS zone name (trailing dot optional) */
8766
- zone_name: string;
9157
+ email_forward_id: TypeId<"email_forward">;
8767
9158
  };
8768
9159
  cookie?: never;
8769
9160
  };
@@ -8776,6 +9167,38 @@ export interface operations {
8776
9167
  };
8777
9168
  content?: never;
8778
9169
  };
9170
+ /** @description Unauthorized */
9171
+ 401: {
9172
+ headers: {
9173
+ [name: string]: unknown;
9174
+ };
9175
+ content: {
9176
+ /** @example {
9177
+ * "code": "ERROR_AUTHENTICATION",
9178
+ * "detail": "Additional error context.",
9179
+ * "status": 401,
9180
+ * "title": "Authentication Error",
9181
+ * "type": "authentication"
9182
+ * } */
9183
+ "application/problem+json": components["schemas"]["Problem"];
9184
+ };
9185
+ };
9186
+ /** @description Forbidden */
9187
+ 403: {
9188
+ headers: {
9189
+ [name: string]: unknown;
9190
+ };
9191
+ content: {
9192
+ /** @example {
9193
+ * "code": "ERROR_PERMISSION_DENIED",
9194
+ * "detail": "Insufficient permissions to perform this action",
9195
+ * "status": 403,
9196
+ * "title": "Permission Denied",
9197
+ * "type": "permission-denied"
9198
+ * } */
9199
+ "application/problem+json": components["schemas"]["Problem"];
9200
+ };
9201
+ };
8779
9202
  /** @description Validation Error */
8780
9203
  422: {
8781
9204
  headers: {
@@ -8787,13 +9210,196 @@ export interface operations {
8787
9210
  };
8788
9211
  };
8789
9212
  };
8790
- disable_email_forward_v1_email_forwards__zone_name__disable_patch: {
9213
+ create_email_forward_alias_v1_email_forwards__email_forward_id__aliases_post: {
8791
9214
  parameters: {
8792
9215
  query?: never;
8793
9216
  header?: never;
8794
9217
  path: {
8795
- /** @description DNS zone name (trailing dot optional) */
8796
- zone_name: string;
9218
+ email_forward_id: TypeId<"email_forward">;
9219
+ };
9220
+ cookie?: never;
9221
+ };
9222
+ requestBody: {
9223
+ content: {
9224
+ "application/json": components["schemas"]["EmailForwardAliasCreate"];
9225
+ };
9226
+ };
9227
+ responses: {
9228
+ /** @description Successful Response */
9229
+ 201: {
9230
+ headers: {
9231
+ [name: string]: unknown;
9232
+ };
9233
+ content: {
9234
+ "application/json": components["schemas"]["EmailForwardAlias"];
9235
+ };
9236
+ };
9237
+ /** @description Unauthorized */
9238
+ 401: {
9239
+ headers: {
9240
+ [name: string]: unknown;
9241
+ };
9242
+ content: {
9243
+ /** @example {
9244
+ * "code": "ERROR_AUTHENTICATION",
9245
+ * "detail": "Additional error context.",
9246
+ * "status": 401,
9247
+ * "title": "Authentication Error",
9248
+ * "type": "authentication"
9249
+ * } */
9250
+ "application/problem+json": components["schemas"]["Problem"];
9251
+ };
9252
+ };
9253
+ /** @description Forbidden */
9254
+ 403: {
9255
+ headers: {
9256
+ [name: string]: unknown;
9257
+ };
9258
+ content: {
9259
+ /** @example {
9260
+ * "code": "ERROR_PERMISSION_DENIED",
9261
+ * "detail": "Insufficient permissions to perform this action",
9262
+ * "status": 403,
9263
+ * "title": "Permission Denied",
9264
+ * "type": "permission-denied"
9265
+ * } */
9266
+ "application/problem+json": components["schemas"]["Problem"];
9267
+ };
9268
+ };
9269
+ /** @description Not Found */
9270
+ 404: {
9271
+ headers: {
9272
+ [name: string]: unknown;
9273
+ };
9274
+ content: {
9275
+ /** @example {
9276
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
9277
+ * "detail": "Email forward not found for hostname: Additional error context.",
9278
+ * "status": 404,
9279
+ * "title": "Email Forward Error",
9280
+ * "type": "email-forward-not-found"
9281
+ * } */
9282
+ "application/problem+json": components["schemas"]["Problem"];
9283
+ };
9284
+ };
9285
+ /** @description Conflict */
9286
+ 409: {
9287
+ headers: {
9288
+ [name: string]: unknown;
9289
+ };
9290
+ content: {
9291
+ /** @example {
9292
+ * "code": "ERROR_EMAIL_FORWARD_ALIAS_ALREADY_EXISTS",
9293
+ * "detail": "Additional error context.",
9294
+ * "status": 409,
9295
+ * "title": "Email Forward Error",
9296
+ * "type": "email-forward-alias-already-exists"
9297
+ * } */
9298
+ "application/problem+json": components["schemas"]["Problem"];
9299
+ };
9300
+ };
9301
+ /** @description Validation Error */
9302
+ 422: {
9303
+ headers: {
9304
+ [name: string]: unknown;
9305
+ };
9306
+ content: {
9307
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
9308
+ };
9309
+ };
9310
+ };
9311
+ };
9312
+ update_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__put: {
9313
+ parameters: {
9314
+ query?: never;
9315
+ header?: never;
9316
+ path: {
9317
+ email_forward_id: TypeId<"email_forward">;
9318
+ alias_id: TypeId<"email_forward_alias">;
9319
+ };
9320
+ cookie?: never;
9321
+ };
9322
+ requestBody: {
9323
+ content: {
9324
+ "application/json": components["schemas"]["EmailForwardAliasUpdate"];
9325
+ };
9326
+ };
9327
+ responses: {
9328
+ /** @description Successful Response */
9329
+ 200: {
9330
+ headers: {
9331
+ [name: string]: unknown;
9332
+ };
9333
+ content: {
9334
+ "application/json": components["schemas"]["EmailForwardAlias"];
9335
+ };
9336
+ };
9337
+ /** @description Unauthorized */
9338
+ 401: {
9339
+ headers: {
9340
+ [name: string]: unknown;
9341
+ };
9342
+ content: {
9343
+ /** @example {
9344
+ * "code": "ERROR_AUTHENTICATION",
9345
+ * "detail": "Additional error context.",
9346
+ * "status": 401,
9347
+ * "title": "Authentication Error",
9348
+ * "type": "authentication"
9349
+ * } */
9350
+ "application/problem+json": components["schemas"]["Problem"];
9351
+ };
9352
+ };
9353
+ /** @description Forbidden */
9354
+ 403: {
9355
+ headers: {
9356
+ [name: string]: unknown;
9357
+ };
9358
+ content: {
9359
+ /** @example {
9360
+ * "code": "ERROR_PERMISSION_DENIED",
9361
+ * "detail": "Insufficient permissions to perform this action",
9362
+ * "status": 403,
9363
+ * "title": "Permission Denied",
9364
+ * "type": "permission-denied"
9365
+ * } */
9366
+ "application/problem+json": components["schemas"]["Problem"];
9367
+ };
9368
+ };
9369
+ /** @description Not Found */
9370
+ 404: {
9371
+ headers: {
9372
+ [name: string]: unknown;
9373
+ };
9374
+ content: {
9375
+ /** @example {
9376
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
9377
+ * "detail": "Email forward not found for hostname: Additional error context.",
9378
+ * "status": 404,
9379
+ * "title": "Email Forward Error",
9380
+ * "type": "email-forward-not-found"
9381
+ * } */
9382
+ "application/problem+json": components["schemas"]["Problem"];
9383
+ };
9384
+ };
9385
+ /** @description Validation Error */
9386
+ 422: {
9387
+ headers: {
9388
+ [name: string]: unknown;
9389
+ };
9390
+ content: {
9391
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
9392
+ };
9393
+ };
9394
+ };
9395
+ };
9396
+ delete_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__delete: {
9397
+ parameters: {
9398
+ query?: never;
9399
+ header?: never;
9400
+ path: {
9401
+ email_forward_id: TypeId<"email_forward">;
9402
+ alias_id: TypeId<"email_forward_alias">;
8797
9403
  };
8798
9404
  cookie?: never;
8799
9405
  };
@@ -8806,6 +9412,54 @@ export interface operations {
8806
9412
  };
8807
9413
  content?: never;
8808
9414
  };
9415
+ /** @description Unauthorized */
9416
+ 401: {
9417
+ headers: {
9418
+ [name: string]: unknown;
9419
+ };
9420
+ content: {
9421
+ /** @example {
9422
+ * "code": "ERROR_AUTHENTICATION",
9423
+ * "detail": "Additional error context.",
9424
+ * "status": 401,
9425
+ * "title": "Authentication Error",
9426
+ * "type": "authentication"
9427
+ * } */
9428
+ "application/problem+json": components["schemas"]["Problem"];
9429
+ };
9430
+ };
9431
+ /** @description Forbidden */
9432
+ 403: {
9433
+ headers: {
9434
+ [name: string]: unknown;
9435
+ };
9436
+ content: {
9437
+ /** @example {
9438
+ * "code": "ERROR_PERMISSION_DENIED",
9439
+ * "detail": "Insufficient permissions to perform this action",
9440
+ * "status": 403,
9441
+ * "title": "Permission Denied",
9442
+ * "type": "permission-denied"
9443
+ * } */
9444
+ "application/problem+json": components["schemas"]["Problem"];
9445
+ };
9446
+ };
9447
+ /** @description Not Found */
9448
+ 404: {
9449
+ headers: {
9450
+ [name: string]: unknown;
9451
+ };
9452
+ content: {
9453
+ /** @example {
9454
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
9455
+ * "detail": "Email forward not found for hostname: Additional error context.",
9456
+ * "status": 404,
9457
+ * "title": "Email Forward Error",
9458
+ * "type": "email-forward-not-found"
9459
+ * } */
9460
+ "application/problem+json": components["schemas"]["Problem"];
9461
+ };
9462
+ };
8809
9463
  /** @description Validation Error */
8810
9464
  422: {
8811
9465
  headers: {
@@ -8817,15 +9471,89 @@ export interface operations {
8817
9471
  };
8818
9472
  };
8819
9473
  };
8820
- enable_email_forward_v1_email_forwards__zone_name__enable_patch: {
9474
+ disable_email_forward_v1_email_forwards__email_forward_id__disable_patch: {
8821
9475
  parameters: {
8822
- query?: {
8823
- auto_create_zone?: boolean;
9476
+ query?: never;
9477
+ header?: never;
9478
+ path: {
9479
+ email_forward_id: TypeId<"email_forward">;
8824
9480
  };
9481
+ cookie?: never;
9482
+ };
9483
+ requestBody?: never;
9484
+ responses: {
9485
+ /** @description Successful Response */
9486
+ 204: {
9487
+ headers: {
9488
+ [name: string]: unknown;
9489
+ };
9490
+ content?: never;
9491
+ };
9492
+ /** @description Unauthorized */
9493
+ 401: {
9494
+ headers: {
9495
+ [name: string]: unknown;
9496
+ };
9497
+ content: {
9498
+ /** @example {
9499
+ * "code": "ERROR_AUTHENTICATION",
9500
+ * "detail": "Additional error context.",
9501
+ * "status": 401,
9502
+ * "title": "Authentication Error",
9503
+ * "type": "authentication"
9504
+ * } */
9505
+ "application/problem+json": components["schemas"]["Problem"];
9506
+ };
9507
+ };
9508
+ /** @description Forbidden */
9509
+ 403: {
9510
+ headers: {
9511
+ [name: string]: unknown;
9512
+ };
9513
+ content: {
9514
+ /** @example {
9515
+ * "code": "ERROR_PERMISSION_DENIED",
9516
+ * "detail": "Insufficient permissions to perform this action",
9517
+ * "status": 403,
9518
+ * "title": "Permission Denied",
9519
+ * "type": "permission-denied"
9520
+ * } */
9521
+ "application/problem+json": components["schemas"]["Problem"];
9522
+ };
9523
+ };
9524
+ /** @description Not Found */
9525
+ 404: {
9526
+ headers: {
9527
+ [name: string]: unknown;
9528
+ };
9529
+ content: {
9530
+ /** @example {
9531
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
9532
+ * "detail": "Email forward not found for hostname: Additional error context.",
9533
+ * "status": 404,
9534
+ * "title": "Email Forward Error",
9535
+ * "type": "email-forward-not-found"
9536
+ * } */
9537
+ "application/problem+json": components["schemas"]["Problem"];
9538
+ };
9539
+ };
9540
+ /** @description Validation Error */
9541
+ 422: {
9542
+ headers: {
9543
+ [name: string]: unknown;
9544
+ };
9545
+ content: {
9546
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
9547
+ };
9548
+ };
9549
+ };
9550
+ };
9551
+ enable_email_forward_v1_email_forwards__email_forward_id__enable_patch: {
9552
+ parameters: {
9553
+ query?: never;
8825
9554
  header?: never;
8826
9555
  path: {
8827
- /** @description DNS zone name (trailing dot optional) */
8828
- zone_name: string;
9556
+ email_forward_id: TypeId<"email_forward">;
8829
9557
  };
8830
9558
  cookie?: never;
8831
9559
  };
@@ -8838,6 +9566,54 @@ export interface operations {
8838
9566
  };
8839
9567
  content?: never;
8840
9568
  };
9569
+ /** @description Unauthorized */
9570
+ 401: {
9571
+ headers: {
9572
+ [name: string]: unknown;
9573
+ };
9574
+ content: {
9575
+ /** @example {
9576
+ * "code": "ERROR_AUTHENTICATION",
9577
+ * "detail": "Additional error context.",
9578
+ * "status": 401,
9579
+ * "title": "Authentication Error",
9580
+ * "type": "authentication"
9581
+ * } */
9582
+ "application/problem+json": components["schemas"]["Problem"];
9583
+ };
9584
+ };
9585
+ /** @description Forbidden */
9586
+ 403: {
9587
+ headers: {
9588
+ [name: string]: unknown;
9589
+ };
9590
+ content: {
9591
+ /** @example {
9592
+ * "code": "ERROR_PERMISSION_DENIED",
9593
+ * "detail": "Insufficient permissions to perform this action",
9594
+ * "status": 403,
9595
+ * "title": "Permission Denied",
9596
+ * "type": "permission-denied"
9597
+ * } */
9598
+ "application/problem+json": components["schemas"]["Problem"];
9599
+ };
9600
+ };
9601
+ /** @description Not Found */
9602
+ 404: {
9603
+ headers: {
9604
+ [name: string]: unknown;
9605
+ };
9606
+ content: {
9607
+ /** @example {
9608
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
9609
+ * "detail": "Email forward not found for hostname: Additional error context.",
9610
+ * "status": 404,
9611
+ * "title": "Email Forward Error",
9612
+ * "type": "email-forward-not-found"
9613
+ * } */
9614
+ "application/problem+json": components["schemas"]["Problem"];
9615
+ };
9616
+ };
8841
9617
  /** @description Validation Error */
8842
9618
  422: {
8843
9619
  headers: {