@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.
@@ -34,7 +34,7 @@ import { operations } from '../schema';
34
34
 
35
35
  import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
36
36
 
37
- import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET ArchiveObjectLogs endpoint
@@ -840,6 +840,45 @@ export type GET_DnsDomainForwards_Request = {
840
840
  */
841
841
  export type GET_DnsDomainForwards_Request_Query = GET_DnsDomainForwards_Request['parameters']['query'];
842
842
 
843
+ /**
844
+ * Request type for GET DnsEmailForwards endpoint
845
+ *
846
+ * List email forwards by zone
847
+ * Retrieves a paginated list of email forwards grouped by DNS zones.
848
+ *
849
+ * @remarks
850
+ * This type defines the complete request structure for the GET DnsEmailForwards endpoint.
851
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
852
+ * Use this type to ensure type safety when making API requests to this endpoint.
853
+ *
854
+ * @example
855
+ * Use this type to ensure type safety when making API requests to this endpoint.
856
+ *
857
+ * @path /v1/dns/email-forwards
858
+ *
859
+ * @see {@link GET_DnsEmailForwards_Request_Query} - Query parameters type
860
+ * @see {@link GET_DnsEmailForwards_Request_Path} - Path parameters type
861
+ * @see {@link GET_DnsEmailForwards_Request_Body} - Request body type
862
+ */
863
+ export type GET_DnsEmailForwards_Request = {
864
+ parameters: {
865
+ query: operations['list_email_forwards_by_zone_v1_dns_email_forwards_get']['parameters']['query'];
866
+ };
867
+ }
868
+ /**
869
+ * Query parameters for GET /v1/dns/email-forwards
870
+ *
871
+ * @remarks
872
+ * This type defines the query parameters for the GET /v1/dns/email-forwards endpoint.
873
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
874
+ *
875
+ * @example
876
+ * Use this type to ensure type safety for query parameters.
877
+ *
878
+ * @path /v1/dns/email-forwards
879
+ */
880
+ export type GET_DnsEmailForwards_Request_Query = GET_DnsEmailForwards_Request['parameters']['query'];
881
+
843
882
  /**
844
883
  * Request type for GET DnsSummary endpoint
845
884
  *
@@ -1063,6 +1102,47 @@ export type GET_DnsZoneNameDomainForwards_Request = {
1063
1102
  */
1064
1103
  export type GET_DnsZoneNameDomainForwards_Request_Path = GET_DnsZoneNameDomainForwards_Request['parameters']['path'];
1065
1104
 
1105
+ /**
1106
+ * Request type for GET DnsZoneNameEmailForwards endpoint
1107
+ *
1108
+ * List email forwards for a zone
1109
+ * Retrieves all email forwards configured for the specified DNS zone, including subdomains and all aliases.
1110
+ *
1111
+ * @remarks
1112
+ * This type defines the complete request structure for the GET DnsZoneNameEmailForwards endpoint.
1113
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1114
+ * Use this type to ensure type safety when making API requests to this endpoint.
1115
+ *
1116
+ * @example
1117
+ * Use this type to ensure type safety when making API requests to this endpoint.
1118
+ *
1119
+ * @path /v1/dns/{zone_name}/email-forwards
1120
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1121
+ *
1122
+ * @see {@link GET_DnsZoneNameEmailForwards_Request_Query} - Query parameters type
1123
+ * @see {@link GET_DnsZoneNameEmailForwards_Request_Path} - Path parameters type
1124
+ * @see {@link GET_DnsZoneNameEmailForwards_Request_Body} - Request body type
1125
+ */
1126
+ export type GET_DnsZoneNameEmailForwards_Request = {
1127
+ parameters: {
1128
+ path: operations['list_zone_email_forwards_v1_dns__zone_name__email_forwards_get']['parameters']['path'];
1129
+ };
1130
+ }
1131
+ /**
1132
+ * Path parameters for GET /v1/dns/{zone_name}/email-forwards
1133
+ *
1134
+ * @remarks
1135
+ * This type defines the path parameters for the GET /v1/dns/{zone_name}/email-forwards endpoint.
1136
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1137
+ *
1138
+ * @example
1139
+ * Use this type to ensure type safety for path parameters.
1140
+ *
1141
+ * @path /v1/dns/{zone_name}/email-forwards
1142
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1143
+ */
1144
+ export type GET_DnsZoneNameEmailForwards_Request_Path = GET_DnsZoneNameEmailForwards_Request['parameters']['path'];
1145
+
1066
1146
  /**
1067
1147
  * Request type for PATCH DnsZoneNameRecords endpoint
1068
1148
  *
@@ -2588,380 +2668,381 @@ export type POST_DomainsTransfer_Request = {
2588
2668
  export type POST_DomainsTransfer_Request_Body = POST_DomainsTransfer_Request['requestBody'];
2589
2669
 
2590
2670
  /**
2591
- * Request type for DELETE EmailForwardsZoneNameAliases endpoint
2671
+ * Request type for GET EmailForwards endpoint
2592
2672
  *
2593
- * Delete Email Forward Aliases
2673
+ * List all email forwards
2674
+ * Retrieves a paginated list of all email forwards for the organization.
2594
2675
  *
2595
2676
  * @remarks
2596
- * This type defines the complete request structure for the DELETE EmailForwardsZoneNameAliases endpoint.
2677
+ * This type defines the complete request structure for the GET EmailForwards endpoint.
2597
2678
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2598
2679
  * Use this type to ensure type safety when making API requests to this endpoint.
2599
2680
  *
2600
2681
  * @example
2601
2682
  * Use this type to ensure type safety when making API requests to this endpoint.
2602
2683
  *
2603
- * @path /v1/email-forwards/{zone_name}/aliases
2604
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2684
+ * @path /v1/email-forwards
2605
2685
  *
2606
- * @see {@link DELETE_EmailForwardsZoneNameAliases_Request_Query} - Query parameters type
2607
- * @see {@link DELETE_EmailForwardsZoneNameAliases_Request_Path} - Path parameters type
2608
- * @see {@link DELETE_EmailForwardsZoneNameAliases_Request_Body} - Request body type
2686
+ * @see {@link GET_EmailForwards_Request_Query} - Query parameters type
2687
+ * @see {@link GET_EmailForwards_Request_Path} - Path parameters type
2688
+ * @see {@link GET_EmailForwards_Request_Body} - Request body type
2609
2689
  */
2610
- export type DELETE_EmailForwardsZoneNameAliases_Request = {
2690
+ export type GET_EmailForwards_Request = {
2611
2691
  parameters: {
2612
- path: operations['delete_email_forward_aliases_v1_email_forwards__zone_name__aliases_delete']['parameters']['path'];
2692
+ query: operations['list_email_forwards_v1_email_forwards_get']['parameters']['query'];
2613
2693
  };
2614
2694
  }
2615
2695
  /**
2616
- * Path parameters for DELETE /v1/email-forwards/{zone_name}/aliases
2696
+ * Query parameters for GET /v1/email-forwards
2617
2697
  *
2618
2698
  * @remarks
2619
- * This type defines the path parameters for the DELETE /v1/email-forwards/{zone_name}/aliases endpoint.
2620
- * It provides type safety for all path parameters as defined in the OpenAPI specification.
2699
+ * This type defines the query parameters for the GET /v1/email-forwards endpoint.
2700
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
2621
2701
  *
2622
2702
  * @example
2623
- * Use this type to ensure type safety for path parameters.
2703
+ * Use this type to ensure type safety for query parameters.
2624
2704
  *
2625
- * @path /v1/email-forwards/{zone_name}/aliases
2626
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2705
+ * @path /v1/email-forwards
2627
2706
  */
2628
- export type DELETE_EmailForwardsZoneNameAliases_Request_Path = DELETE_EmailForwardsZoneNameAliases_Request['parameters']['path'];
2707
+ export type GET_EmailForwards_Request_Query = GET_EmailForwards_Request['parameters']['query'];
2629
2708
 
2630
2709
  /**
2631
- * Request type for GET EmailForwardsZoneNameAliases endpoint
2710
+ * Request type for POST EmailForwards endpoint
2632
2711
  *
2633
- * Get Email Forward Aliases
2712
+ * Create email forward configuration
2713
+ * Creates an email forward configuration with optional aliases. Can be created enabled or disabled (default: disabled). Includes created_on and updated_on timestamps.
2634
2714
  *
2635
2715
  * @remarks
2636
- * This type defines the complete request structure for the GET EmailForwardsZoneNameAliases endpoint.
2716
+ * This type defines the complete request structure for the POST EmailForwards endpoint.
2637
2717
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2638
2718
  * Use this type to ensure type safety when making API requests to this endpoint.
2639
2719
  *
2640
2720
  * @example
2641
2721
  * Use this type to ensure type safety when making API requests to this endpoint.
2642
2722
  *
2643
- * @path /v1/email-forwards/{zone_name}/aliases
2644
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2723
+ * @path /v1/email-forwards
2645
2724
  *
2646
- * @see {@link GET_EmailForwardsZoneNameAliases_Request_Query} - Query parameters type
2647
- * @see {@link GET_EmailForwardsZoneNameAliases_Request_Path} - Path parameters type
2648
- * @see {@link GET_EmailForwardsZoneNameAliases_Request_Body} - Request body type
2725
+ * @see {@link POST_EmailForwards_Request_Query} - Query parameters type
2726
+ * @see {@link POST_EmailForwards_Request_Path} - Path parameters type
2727
+ * @see {@link POST_EmailForwards_Request_Body} - Request body type
2649
2728
  */
2650
- export type GET_EmailForwardsZoneNameAliases_Request = {
2651
- parameters: {
2652
- query: operations['get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get']['parameters']['query'];
2653
- path: operations['get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get']['parameters']['path'];
2654
- };
2729
+ export type POST_EmailForwards_Request = {
2730
+ requestBody: EmailForwardCreate;
2655
2731
  }
2656
2732
  /**
2657
- * Query parameters for GET /v1/email-forwards/{zone_name}/aliases
2733
+ * Request body for POST /v1/email-forwards
2658
2734
  *
2659
2735
  * @remarks
2660
- * This type defines the query parameters for the GET /v1/email-forwards/{zone_name}/aliases endpoint.
2661
- * It provides type safety for all query parameters as defined in the OpenAPI specification.
2736
+ * This type defines the request body structure for the POST /v1/email-forwards endpoint.
2737
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2662
2738
  *
2663
2739
  * @example
2664
- * Use this type to ensure type safety for query parameters.
2740
+ * Use this type to ensure type safety for request body structure.
2741
+ *
2742
+ * @path /v1/email-forwards
2743
+ */
2744
+ export type POST_EmailForwards_Request_Body = POST_EmailForwards_Request['requestBody'];
2745
+
2746
+ /**
2747
+ * Request type for DELETE EmailForwardsEmailForwardId endpoint
2748
+ *
2749
+ * Delete email forward configuration
2750
+ * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
2751
+ *
2752
+ * @remarks
2753
+ * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardId endpoint.
2754
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2755
+ * Use this type to ensure type safety when making API requests to this endpoint.
2756
+ *
2757
+ * @example
2758
+ * Use this type to ensure type safety when making API requests to this endpoint.
2759
+ *
2760
+ * @path /v1/email-forwards/{email_forward_id}
2665
2761
  *
2666
- * @path /v1/email-forwards/{zone_name}/aliases
2762
+ * @see {@link DELETE_EmailForwardsEmailForwardId_Request_Query} - Query parameters type
2763
+ * @see {@link DELETE_EmailForwardsEmailForwardId_Request_Path} - Path parameters type
2764
+ * @see {@link DELETE_EmailForwardsEmailForwardId_Request_Body} - Request body type
2667
2765
  */
2668
- export type GET_EmailForwardsZoneNameAliases_Request_Query = GET_EmailForwardsZoneNameAliases_Request['parameters']['query'];
2766
+ export type DELETE_EmailForwardsEmailForwardId_Request = {
2767
+ parameters: {
2768
+ path: operations['delete_email_forward_v1_email_forwards__email_forward_id__delete']['parameters']['path'];
2769
+ };
2770
+ }
2669
2771
  /**
2670
- * Path parameters for GET /v1/email-forwards/{zone_name}/aliases
2772
+ * Path parameters for DELETE /v1/email-forwards/{email_forward_id}
2671
2773
  *
2672
2774
  * @remarks
2673
- * This type defines the path parameters for the GET /v1/email-forwards/{zone_name}/aliases endpoint.
2775
+ * This type defines the path parameters for the DELETE /v1/email-forwards/{email_forward_id} endpoint.
2674
2776
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2675
2777
  *
2676
2778
  * @example
2677
2779
  * Use this type to ensure type safety for path parameters.
2678
2780
  *
2679
- * @path /v1/email-forwards/{zone_name}/aliases
2680
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2781
+ * @path /v1/email-forwards/{email_forward_id}
2681
2782
  */
2682
- export type GET_EmailForwardsZoneNameAliases_Request_Path = GET_EmailForwardsZoneNameAliases_Request['parameters']['path'];
2783
+ export type DELETE_EmailForwardsEmailForwardId_Request_Path = DELETE_EmailForwardsEmailForwardId_Request['parameters']['path'];
2683
2784
 
2684
2785
  /**
2685
- * Request type for POST EmailForwardsZoneNameAliases endpoint
2786
+ * Request type for GET EmailForwardsEmailForwardId endpoint
2686
2787
  *
2687
- * Create Email Forward Alias
2788
+ * Get email forward configuration
2789
+ * Retrieves the email forward configuration for the specified zone including all aliases
2688
2790
  *
2689
2791
  * @remarks
2690
- * This type defines the complete request structure for the POST EmailForwardsZoneNameAliases endpoint.
2792
+ * This type defines the complete request structure for the GET EmailForwardsEmailForwardId endpoint.
2691
2793
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2692
2794
  * Use this type to ensure type safety when making API requests to this endpoint.
2693
2795
  *
2694
2796
  * @example
2695
2797
  * Use this type to ensure type safety when making API requests to this endpoint.
2696
2798
  *
2697
- * @path /v1/email-forwards/{zone_name}/aliases
2698
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2799
+ * @path /v1/email-forwards/{email_forward_id}
2699
2800
  *
2700
- * @see {@link POST_EmailForwardsZoneNameAliases_Request_Query} - Query parameters type
2701
- * @see {@link POST_EmailForwardsZoneNameAliases_Request_Path} - Path parameters type
2702
- * @see {@link POST_EmailForwardsZoneNameAliases_Request_Body} - Request body type
2801
+ * @see {@link GET_EmailForwardsEmailForwardId_Request_Query} - Query parameters type
2802
+ * @see {@link GET_EmailForwardsEmailForwardId_Request_Path} - Path parameters type
2803
+ * @see {@link GET_EmailForwardsEmailForwardId_Request_Body} - Request body type
2703
2804
  */
2704
- export type POST_EmailForwardsZoneNameAliases_Request = {
2805
+ export type GET_EmailForwardsEmailForwardId_Request = {
2705
2806
  parameters: {
2706
- path: operations['create_email_forward_alias_v1_email_forwards__zone_name__aliases_post']['parameters']['path'];
2807
+ path: operations['get_email_forward_v1_email_forwards__email_forward_id__get']['parameters']['path'];
2707
2808
  };
2708
- requestBody: EmailForwardAlias;
2709
2809
  }
2710
2810
  /**
2711
- * Path parameters for POST /v1/email-forwards/{zone_name}/aliases
2811
+ * Path parameters for GET /v1/email-forwards/{email_forward_id}
2712
2812
  *
2713
2813
  * @remarks
2714
- * This type defines the path parameters for the POST /v1/email-forwards/{zone_name}/aliases endpoint.
2814
+ * This type defines the path parameters for the GET /v1/email-forwards/{email_forward_id} endpoint.
2715
2815
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2716
2816
  *
2717
2817
  * @example
2718
2818
  * Use this type to ensure type safety for path parameters.
2719
2819
  *
2720
- * @path /v1/email-forwards/{zone_name}/aliases
2721
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2722
- */
2723
- export type POST_EmailForwardsZoneNameAliases_Request_Path = POST_EmailForwardsZoneNameAliases_Request['parameters']['path'];
2724
- /**
2725
- * Request body for POST /v1/email-forwards/{zone_name}/aliases
2726
- *
2727
- * @remarks
2728
- * This type defines the request body structure for the POST /v1/email-forwards/{zone_name}/aliases endpoint.
2729
- * It provides type safety for the request body as defined in the OpenAPI specification.
2730
- *
2731
- * @example
2732
- * Use this type to ensure type safety for request body structure.
2733
- *
2734
- * @path /v1/email-forwards/{zone_name}/aliases
2820
+ * @path /v1/email-forwards/{email_forward_id}
2735
2821
  */
2736
- export type POST_EmailForwardsZoneNameAliases_Request_Body = POST_EmailForwardsZoneNameAliases_Request['requestBody'];
2822
+ export type GET_EmailForwardsEmailForwardId_Request_Path = GET_EmailForwardsEmailForwardId_Request['parameters']['path'];
2737
2823
 
2738
2824
  /**
2739
- * Request type for DELETE EmailForwardsZoneNameAliasesAlias endpoint
2825
+ * Request type for POST EmailForwardsEmailForwardIdAliases endpoint
2740
2826
  *
2741
- * Delete Email Forward Alias
2827
+ * Create email forward alias
2828
+ * Creates a new email forward alias for the specified hostname.
2742
2829
  *
2743
2830
  * @remarks
2744
- * This type defines the complete request structure for the DELETE EmailForwardsZoneNameAliasesAlias endpoint.
2831
+ * This type defines the complete request structure for the POST EmailForwardsEmailForwardIdAliases endpoint.
2745
2832
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2746
2833
  * Use this type to ensure type safety when making API requests to this endpoint.
2747
2834
  *
2748
2835
  * @example
2749
2836
  * Use this type to ensure type safety when making API requests to this endpoint.
2750
2837
  *
2751
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2752
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2838
+ * @path /v1/email-forwards/{email_forward_id}/aliases
2753
2839
  *
2754
- * @see {@link DELETE_EmailForwardsZoneNameAliasesAlias_Request_Query} - Query parameters type
2755
- * @see {@link DELETE_EmailForwardsZoneNameAliasesAlias_Request_Path} - Path parameters type
2756
- * @see {@link DELETE_EmailForwardsZoneNameAliasesAlias_Request_Body} - Request body type
2840
+ * @see {@link POST_EmailForwardsEmailForwardIdAliases_Request_Query} - Query parameters type
2841
+ * @see {@link POST_EmailForwardsEmailForwardIdAliases_Request_Path} - Path parameters type
2842
+ * @see {@link POST_EmailForwardsEmailForwardIdAliases_Request_Body} - Request body type
2757
2843
  */
2758
- export type DELETE_EmailForwardsZoneNameAliasesAlias_Request = {
2844
+ export type POST_EmailForwardsEmailForwardIdAliases_Request = {
2759
2845
  parameters: {
2760
- path: operations['delete_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__delete']['parameters']['path'];
2846
+ path: operations['create_email_forward_alias_v1_email_forwards__email_forward_id__aliases_post']['parameters']['path'];
2761
2847
  };
2848
+ requestBody: EmailForwardAliasCreate;
2762
2849
  }
2763
2850
  /**
2764
- * Path parameters for DELETE /v1/email-forwards/{zone_name}/aliases/{alias}
2851
+ * Path parameters for POST /v1/email-forwards/{email_forward_id}/aliases
2765
2852
  *
2766
2853
  * @remarks
2767
- * This type defines the path parameters for the DELETE /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
2854
+ * This type defines the path parameters for the POST /v1/email-forwards/{email_forward_id}/aliases endpoint.
2768
2855
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2769
2856
  *
2770
2857
  * @example
2771
2858
  * Use this type to ensure type safety for path parameters.
2772
2859
  *
2773
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2774
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2860
+ * @path /v1/email-forwards/{email_forward_id}/aliases
2775
2861
  */
2776
- export type DELETE_EmailForwardsZoneNameAliasesAlias_Request_Path = DELETE_EmailForwardsZoneNameAliasesAlias_Request['parameters']['path'];
2862
+ export type POST_EmailForwardsEmailForwardIdAliases_Request_Path = POST_EmailForwardsEmailForwardIdAliases_Request['parameters']['path'];
2863
+ /**
2864
+ * Request body for POST /v1/email-forwards/{email_forward_id}/aliases
2865
+ *
2866
+ * @remarks
2867
+ * This type defines the request body structure for the POST /v1/email-forwards/{email_forward_id}/aliases endpoint.
2868
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2869
+ *
2870
+ * @example
2871
+ * Use this type to ensure type safety for request body structure.
2872
+ *
2873
+ * @path /v1/email-forwards/{email_forward_id}/aliases
2874
+ */
2875
+ export type POST_EmailForwardsEmailForwardIdAliases_Request_Body = POST_EmailForwardsEmailForwardIdAliases_Request['requestBody'];
2777
2876
 
2778
2877
  /**
2779
- * Request type for GET EmailForwardsZoneNameAliasesAlias endpoint
2878
+ * Request type for DELETE EmailForwardsEmailForwardIdAliasesAliasId endpoint
2780
2879
  *
2781
- * Get Email Forward Alias
2880
+ * Delete email forward alias
2881
+ * Deletes a specific email forward alias for the specified zone
2782
2882
  *
2783
2883
  * @remarks
2784
- * This type defines the complete request structure for the GET EmailForwardsZoneNameAliasesAlias endpoint.
2884
+ * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardIdAliasesAliasId endpoint.
2785
2885
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2786
2886
  * Use this type to ensure type safety when making API requests to this endpoint.
2787
2887
  *
2788
2888
  * @example
2789
2889
  * Use this type to ensure type safety when making API requests to this endpoint.
2790
2890
  *
2791
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2792
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2891
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2793
2892
  *
2794
- * @see {@link GET_EmailForwardsZoneNameAliasesAlias_Request_Query} - Query parameters type
2795
- * @see {@link GET_EmailForwardsZoneNameAliasesAlias_Request_Path} - Path parameters type
2796
- * @see {@link GET_EmailForwardsZoneNameAliasesAlias_Request_Body} - Request body type
2893
+ * @see {@link DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request_Query} - Query parameters type
2894
+ * @see {@link DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request_Path} - Path parameters type
2895
+ * @see {@link DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request_Body} - Request body type
2797
2896
  */
2798
- export type GET_EmailForwardsZoneNameAliasesAlias_Request = {
2897
+ export type DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request = {
2799
2898
  parameters: {
2800
- path: operations['get_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__get']['parameters']['path'];
2899
+ path: operations['delete_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__delete']['parameters']['path'];
2801
2900
  };
2802
2901
  }
2803
2902
  /**
2804
- * Path parameters for GET /v1/email-forwards/{zone_name}/aliases/{alias}
2903
+ * Path parameters for DELETE /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2805
2904
  *
2806
2905
  * @remarks
2807
- * This type defines the path parameters for the GET /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
2906
+ * This type defines the path parameters for the DELETE /v1/email-forwards/{email_forward_id}/aliases/{alias_id} endpoint.
2808
2907
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2809
2908
  *
2810
2909
  * @example
2811
2910
  * Use this type to ensure type safety for path parameters.
2812
2911
  *
2813
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2814
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2912
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2815
2913
  */
2816
- export type GET_EmailForwardsZoneNameAliasesAlias_Request_Path = GET_EmailForwardsZoneNameAliasesAlias_Request['parameters']['path'];
2914
+ export type DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request_Path = DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request['parameters']['path'];
2817
2915
 
2818
2916
  /**
2819
- * Request type for PUT EmailForwardsZoneNameAliasesAlias endpoint
2917
+ * Request type for PUT EmailForwardsEmailForwardIdAliasesAliasId endpoint
2820
2918
  *
2821
- * Update Email Forward Alias
2919
+ * Update email forward alias
2920
+ * Updates the forward_to address for a specific email forward alias
2822
2921
  *
2823
2922
  * @remarks
2824
- * This type defines the complete request structure for the PUT EmailForwardsZoneNameAliasesAlias endpoint.
2923
+ * This type defines the complete request structure for the PUT EmailForwardsEmailForwardIdAliasesAliasId endpoint.
2825
2924
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2826
2925
  * Use this type to ensure type safety when making API requests to this endpoint.
2827
2926
  *
2828
2927
  * @example
2829
2928
  * Use this type to ensure type safety when making API requests to this endpoint.
2830
2929
  *
2831
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2832
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2930
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2833
2931
  *
2834
- * @see {@link PUT_EmailForwardsZoneNameAliasesAlias_Request_Query} - Query parameters type
2835
- * @see {@link PUT_EmailForwardsZoneNameAliasesAlias_Request_Path} - Path parameters type
2836
- * @see {@link PUT_EmailForwardsZoneNameAliasesAlias_Request_Body} - Request body type
2932
+ * @see {@link PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request_Query} - Query parameters type
2933
+ * @see {@link PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request_Path} - Path parameters type
2934
+ * @see {@link PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request_Body} - Request body type
2837
2935
  */
2838
- export type PUT_EmailForwardsZoneNameAliasesAlias_Request = {
2936
+ export type PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request = {
2839
2937
  parameters: {
2840
- path: operations['update_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__put']['parameters']['path'];
2938
+ path: operations['update_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__put']['parameters']['path'];
2841
2939
  };
2842
2940
  requestBody: EmailForwardAliasUpdate;
2843
2941
  }
2844
2942
  /**
2845
- * Path parameters for PUT /v1/email-forwards/{zone_name}/aliases/{alias}
2943
+ * Path parameters for PUT /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2846
2944
  *
2847
2945
  * @remarks
2848
- * This type defines the path parameters for the PUT /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
2946
+ * This type defines the path parameters for the PUT /v1/email-forwards/{email_forward_id}/aliases/{alias_id} endpoint.
2849
2947
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2850
2948
  *
2851
2949
  * @example
2852
2950
  * Use this type to ensure type safety for path parameters.
2853
2951
  *
2854
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2855
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2952
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2856
2953
  */
2857
- export type PUT_EmailForwardsZoneNameAliasesAlias_Request_Path = PUT_EmailForwardsZoneNameAliasesAlias_Request['parameters']['path'];
2954
+ export type PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request_Path = PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request['parameters']['path'];
2858
2955
  /**
2859
- * Request body for PUT /v1/email-forwards/{zone_name}/aliases/{alias}
2956
+ * Request body for PUT /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2860
2957
  *
2861
2958
  * @remarks
2862
- * This type defines the request body structure for the PUT /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
2959
+ * This type defines the request body structure for the PUT /v1/email-forwards/{email_forward_id}/aliases/{alias_id} endpoint.
2863
2960
  * It provides type safety for the request body as defined in the OpenAPI specification.
2864
2961
  *
2865
2962
  * @example
2866
2963
  * Use this type to ensure type safety for request body structure.
2867
2964
  *
2868
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2965
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
2869
2966
  */
2870
- export type PUT_EmailForwardsZoneNameAliasesAlias_Request_Body = PUT_EmailForwardsZoneNameAliasesAlias_Request['requestBody'];
2967
+ export type PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request_Body = PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request['requestBody'];
2871
2968
 
2872
2969
  /**
2873
- * Request type for PATCH EmailForwardsZoneNameDisable endpoint
2970
+ * Request type for PATCH EmailForwardsEmailForwardIdDisable endpoint
2874
2971
  *
2875
- * Disable Email Forward
2972
+ * Disable email forwarding
2973
+ * 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.
2876
2974
  *
2877
2975
  * @remarks
2878
- * This type defines the complete request structure for the PATCH EmailForwardsZoneNameDisable endpoint.
2976
+ * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardIdDisable endpoint.
2879
2977
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2880
2978
  * Use this type to ensure type safety when making API requests to this endpoint.
2881
2979
  *
2882
2980
  * @example
2883
2981
  * Use this type to ensure type safety when making API requests to this endpoint.
2884
2982
  *
2885
- * @path /v1/email-forwards/{zone_name}/disable
2886
- * @param zone_name (path) - DNS zone name (trailing dot optional)
2983
+ * @path /v1/email-forwards/{email_forward_id}/disable
2887
2984
  *
2888
- * @see {@link PATCH_EmailForwardsZoneNameDisable_Request_Query} - Query parameters type
2889
- * @see {@link PATCH_EmailForwardsZoneNameDisable_Request_Path} - Path parameters type
2890
- * @see {@link PATCH_EmailForwardsZoneNameDisable_Request_Body} - Request body type
2985
+ * @see {@link PATCH_EmailForwardsEmailForwardIdDisable_Request_Query} - Query parameters type
2986
+ * @see {@link PATCH_EmailForwardsEmailForwardIdDisable_Request_Path} - Path parameters type
2987
+ * @see {@link PATCH_EmailForwardsEmailForwardIdDisable_Request_Body} - Request body type
2891
2988
  */
2892
- export type PATCH_EmailForwardsZoneNameDisable_Request = {
2989
+ export type PATCH_EmailForwardsEmailForwardIdDisable_Request = {
2893
2990
  parameters: {
2894
- path: operations['disable_email_forward_v1_email_forwards__zone_name__disable_patch']['parameters']['path'];
2991
+ path: operations['disable_email_forward_v1_email_forwards__email_forward_id__disable_patch']['parameters']['path'];
2895
2992
  };
2896
2993
  }
2897
2994
  /**
2898
- * Path parameters for PATCH /v1/email-forwards/{zone_name}/disable
2995
+ * Path parameters for PATCH /v1/email-forwards/{email_forward_id}/disable
2899
2996
  *
2900
2997
  * @remarks
2901
- * This type defines the path parameters for the PATCH /v1/email-forwards/{zone_name}/disable endpoint.
2998
+ * This type defines the path parameters for the PATCH /v1/email-forwards/{email_forward_id}/disable endpoint.
2902
2999
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2903
3000
  *
2904
3001
  * @example
2905
3002
  * Use this type to ensure type safety for path parameters.
2906
3003
  *
2907
- * @path /v1/email-forwards/{zone_name}/disable
2908
- * @param zone_name (path) - DNS zone name (trailing dot optional)
3004
+ * @path /v1/email-forwards/{email_forward_id}/disable
2909
3005
  */
2910
- export type PATCH_EmailForwardsZoneNameDisable_Request_Path = PATCH_EmailForwardsZoneNameDisable_Request['parameters']['path'];
3006
+ export type PATCH_EmailForwardsEmailForwardIdDisable_Request_Path = PATCH_EmailForwardsEmailForwardIdDisable_Request['parameters']['path'];
2911
3007
 
2912
3008
  /**
2913
- * Request type for PATCH EmailForwardsZoneNameEnable endpoint
3009
+ * Request type for PATCH EmailForwardsEmailForwardIdEnable endpoint
2914
3010
  *
2915
- * Enable Email Forward
3011
+ * Enable email forwarding
3012
+ * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
2916
3013
  *
2917
3014
  * @remarks
2918
- * This type defines the complete request structure for the PATCH EmailForwardsZoneNameEnable endpoint.
3015
+ * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardIdEnable endpoint.
2919
3016
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2920
3017
  * Use this type to ensure type safety when making API requests to this endpoint.
2921
3018
  *
2922
3019
  * @example
2923
3020
  * Use this type to ensure type safety when making API requests to this endpoint.
2924
3021
  *
2925
- * @path /v1/email-forwards/{zone_name}/enable
2926
- * @param zone_name (path) - DNS zone name (trailing dot optional)
3022
+ * @path /v1/email-forwards/{email_forward_id}/enable
2927
3023
  *
2928
- * @see {@link PATCH_EmailForwardsZoneNameEnable_Request_Query} - Query parameters type
2929
- * @see {@link PATCH_EmailForwardsZoneNameEnable_Request_Path} - Path parameters type
2930
- * @see {@link PATCH_EmailForwardsZoneNameEnable_Request_Body} - Request body type
3024
+ * @see {@link PATCH_EmailForwardsEmailForwardIdEnable_Request_Query} - Query parameters type
3025
+ * @see {@link PATCH_EmailForwardsEmailForwardIdEnable_Request_Path} - Path parameters type
3026
+ * @see {@link PATCH_EmailForwardsEmailForwardIdEnable_Request_Body} - Request body type
2931
3027
  */
2932
- export type PATCH_EmailForwardsZoneNameEnable_Request = {
3028
+ export type PATCH_EmailForwardsEmailForwardIdEnable_Request = {
2933
3029
  parameters: {
2934
- query: operations['enable_email_forward_v1_email_forwards__zone_name__enable_patch']['parameters']['query'];
2935
- path: operations['enable_email_forward_v1_email_forwards__zone_name__enable_patch']['parameters']['path'];
3030
+ path: operations['enable_email_forward_v1_email_forwards__email_forward_id__enable_patch']['parameters']['path'];
2936
3031
  };
2937
3032
  }
2938
3033
  /**
2939
- * Query parameters for PATCH /v1/email-forwards/{zone_name}/enable
3034
+ * Path parameters for PATCH /v1/email-forwards/{email_forward_id}/enable
2940
3035
  *
2941
3036
  * @remarks
2942
- * This type defines the query parameters for the PATCH /v1/email-forwards/{zone_name}/enable endpoint.
2943
- * It provides type safety for all query parameters as defined in the OpenAPI specification.
2944
- *
2945
- * @example
2946
- * Use this type to ensure type safety for query parameters.
2947
- *
2948
- * @path /v1/email-forwards/{zone_name}/enable
2949
- */
2950
- export type PATCH_EmailForwardsZoneNameEnable_Request_Query = PATCH_EmailForwardsZoneNameEnable_Request['parameters']['query'];
2951
- /**
2952
- * Path parameters for PATCH /v1/email-forwards/{zone_name}/enable
2953
- *
2954
- * @remarks
2955
- * This type defines the path parameters for the PATCH /v1/email-forwards/{zone_name}/enable endpoint.
3037
+ * This type defines the path parameters for the PATCH /v1/email-forwards/{email_forward_id}/enable endpoint.
2956
3038
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2957
3039
  *
2958
3040
  * @example
2959
3041
  * Use this type to ensure type safety for path parameters.
2960
3042
  *
2961
- * @path /v1/email-forwards/{zone_name}/enable
2962
- * @param zone_name (path) - DNS zone name (trailing dot optional)
3043
+ * @path /v1/email-forwards/{email_forward_id}/enable
2963
3044
  */
2964
- export type PATCH_EmailForwardsZoneNameEnable_Request_Path = PATCH_EmailForwardsZoneNameEnable_Request['parameters']['path'];
3045
+ export type PATCH_EmailForwardsEmailForwardIdEnable_Request_Path = PATCH_EmailForwardsEmailForwardIdEnable_Request['parameters']['path'];
2965
3046
 
2966
3047
  /**
2967
3048
  * Request type for GET Events endpoint