@opusdns/api 0.15.0 → 0.16.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 { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardCreate, EmailForwardBulkDelete, EmailForwardBulkUpdate, EmailForwardUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, TermsOfServiceAccept, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, TermsOfServiceAccept, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET AuthClientCredentials endpoint
@@ -1819,284 +1819,366 @@ export type POST_DomainsTransfer_Request = {
1819
1819
  export type POST_DomainsTransfer_Request_Body = POST_DomainsTransfer_Request['requestBody'];
1820
1820
 
1821
1821
  /**
1822
- * Request type for GET EmailForwards endpoint
1822
+ * Request type for DELETE EmailForwardsZoneNameAliases endpoint
1823
1823
  *
1824
- * List Email Forwards
1824
+ * Delete Email Forward Aliases
1825
1825
  *
1826
1826
  * @remarks
1827
- * This type defines the complete request structure for the GET EmailForwards endpoint.
1827
+ * This type defines the complete request structure for the DELETE EmailForwardsZoneNameAliases endpoint.
1828
1828
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1829
1829
  * Use this type to ensure type safety when making API requests to this endpoint.
1830
1830
  *
1831
1831
  * @example
1832
1832
  * Use this type to ensure type safety when making API requests to this endpoint.
1833
1833
  *
1834
- * @path /v1/email-forwards
1835
- * @param status (query) - Optional status to filter the results
1836
- * @param source_address (query) - Optional source address to filter the results
1837
- * @param target_address (query) - Optional target address to filter the results
1834
+ * @path /v1/email-forwards/{zone_name}/aliases
1835
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1838
1836
  *
1839
- * @see {@link GET_EmailForwards_Request_Query} - Query parameters type
1840
- * @see {@link GET_EmailForwards_Request_Path} - Path parameters type
1841
- * @see {@link GET_EmailForwards_Request_Body} - Request body type
1837
+ * @see {@link DELETE_EmailForwardsZoneNameAliases_Request_Query} - Query parameters type
1838
+ * @see {@link DELETE_EmailForwardsZoneNameAliases_Request_Path} - Path parameters type
1839
+ * @see {@link DELETE_EmailForwardsZoneNameAliases_Request_Body} - Request body type
1842
1840
  */
1843
- export type GET_EmailForwards_Request = {
1841
+ export type DELETE_EmailForwardsZoneNameAliases_Request = {
1844
1842
  parameters: {
1845
- query: operations['list_email_forwards_v1_email_forwards_get']['parameters']['query'];
1843
+ path: operations['delete_email_forward_aliases_v1_email_forwards__zone_name__aliases_delete']['parameters']['path'];
1846
1844
  };
1847
1845
  }
1848
1846
  /**
1849
- * Query parameters for GET /v1/email-forwards
1847
+ * Path parameters for DELETE /v1/email-forwards/{zone_name}/aliases
1850
1848
  *
1851
1849
  * @remarks
1852
- * This type defines the query parameters for the GET /v1/email-forwards endpoint.
1853
- * It provides type safety for all query parameters as defined in the OpenAPI specification.
1850
+ * This type defines the path parameters for the DELETE /v1/email-forwards/{zone_name}/aliases endpoint.
1851
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1854
1852
  *
1855
1853
  * @example
1856
- * Use this type to ensure type safety for query parameters.
1854
+ * Use this type to ensure type safety for path parameters.
1857
1855
  *
1858
- * @path /v1/email-forwards
1859
- * @param status (query) - Optional status to filter the results
1860
- * @param source_address (query) - Optional source address to filter the results
1861
- * @param target_address (query) - Optional target address to filter the results
1856
+ * @path /v1/email-forwards/{zone_name}/aliases
1857
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1862
1858
  */
1863
- export type GET_EmailForwards_Request_Query = GET_EmailForwards_Request['parameters']['query'];
1859
+ export type DELETE_EmailForwardsZoneNameAliases_Request_Path = DELETE_EmailForwardsZoneNameAliases_Request['parameters']['path'];
1864
1860
 
1865
1861
  /**
1866
- * Request type for POST EmailForwards endpoint
1862
+ * Request type for GET EmailForwardsZoneNameAliases endpoint
1867
1863
  *
1868
- * Create Email Forward
1864
+ * Get Email Forward Aliases
1869
1865
  *
1870
1866
  * @remarks
1871
- * This type defines the complete request structure for the POST EmailForwards endpoint.
1867
+ * This type defines the complete request structure for the GET EmailForwardsZoneNameAliases endpoint.
1872
1868
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1873
1869
  * Use this type to ensure type safety when making API requests to this endpoint.
1874
1870
  *
1875
1871
  * @example
1876
1872
  * Use this type to ensure type safety when making API requests to this endpoint.
1877
1873
  *
1878
- * @path /v1/email-forwards
1874
+ * @path /v1/email-forwards/{zone_name}/aliases
1875
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1879
1876
  *
1880
- * @see {@link POST_EmailForwards_Request_Query} - Query parameters type
1881
- * @see {@link POST_EmailForwards_Request_Path} - Path parameters type
1882
- * @see {@link POST_EmailForwards_Request_Body} - Request body type
1877
+ * @see {@link GET_EmailForwardsZoneNameAliases_Request_Query} - Query parameters type
1878
+ * @see {@link GET_EmailForwardsZoneNameAliases_Request_Path} - Path parameters type
1879
+ * @see {@link GET_EmailForwardsZoneNameAliases_Request_Body} - Request body type
1883
1880
  */
1884
- export type POST_EmailForwards_Request = {
1885
- requestBody: EmailForwardCreate;
1881
+ export type GET_EmailForwardsZoneNameAliases_Request = {
1882
+ parameters: {
1883
+ query: operations['get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get']['parameters']['query'];
1884
+ path: operations['get_email_forward_aliases_v1_email_forwards__zone_name__aliases_get']['parameters']['path'];
1885
+ };
1886
1886
  }
1887
1887
  /**
1888
- * Request body for POST /v1/email-forwards
1888
+ * Query parameters for GET /v1/email-forwards/{zone_name}/aliases
1889
1889
  *
1890
1890
  * @remarks
1891
- * This type defines the request body structure for the POST /v1/email-forwards endpoint.
1892
- * It provides type safety for the request body as defined in the OpenAPI specification.
1891
+ * This type defines the query parameters for the GET /v1/email-forwards/{zone_name}/aliases endpoint.
1892
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
1893
1893
  *
1894
1894
  * @example
1895
- * Use this type to ensure type safety for request body structure.
1895
+ * Use this type to ensure type safety for query parameters.
1896
+ *
1897
+ * @path /v1/email-forwards/{zone_name}/aliases
1898
+ */
1899
+ export type GET_EmailForwardsZoneNameAliases_Request_Query = GET_EmailForwardsZoneNameAliases_Request['parameters']['query'];
1900
+ /**
1901
+ * Path parameters for GET /v1/email-forwards/{zone_name}/aliases
1902
+ *
1903
+ * @remarks
1904
+ * This type defines the path parameters for the GET /v1/email-forwards/{zone_name}/aliases endpoint.
1905
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1896
1906
  *
1897
- * @path /v1/email-forwards
1907
+ * @example
1908
+ * Use this type to ensure type safety for path parameters.
1909
+ *
1910
+ * @path /v1/email-forwards/{zone_name}/aliases
1911
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1898
1912
  */
1899
- export type POST_EmailForwards_Request_Body = POST_EmailForwards_Request['requestBody'];
1913
+ export type GET_EmailForwardsZoneNameAliases_Request_Path = GET_EmailForwardsZoneNameAliases_Request['parameters']['path'];
1900
1914
 
1901
1915
  /**
1902
- * Request type for POST EmailForwardsBulkDelete endpoint
1916
+ * Request type for POST EmailForwardsZoneNameAliases endpoint
1903
1917
  *
1904
- * Bulk Delete Email Forwards
1918
+ * Create Email Forward Alias
1905
1919
  *
1906
1920
  * @remarks
1907
- * This type defines the complete request structure for the POST EmailForwardsBulkDelete endpoint.
1921
+ * This type defines the complete request structure for the POST EmailForwardsZoneNameAliases endpoint.
1908
1922
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1909
1923
  * Use this type to ensure type safety when making API requests to this endpoint.
1910
1924
  *
1911
1925
  * @example
1912
1926
  * Use this type to ensure type safety when making API requests to this endpoint.
1913
1927
  *
1914
- * @path /v1/email-forwards/bulk-delete
1928
+ * @path /v1/email-forwards/{zone_name}/aliases
1929
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1915
1930
  *
1916
- * @see {@link POST_EmailForwardsBulkDelete_Request_Query} - Query parameters type
1917
- * @see {@link POST_EmailForwardsBulkDelete_Request_Path} - Path parameters type
1918
- * @see {@link POST_EmailForwardsBulkDelete_Request_Body} - Request body type
1931
+ * @see {@link POST_EmailForwardsZoneNameAliases_Request_Query} - Query parameters type
1932
+ * @see {@link POST_EmailForwardsZoneNameAliases_Request_Path} - Path parameters type
1933
+ * @see {@link POST_EmailForwardsZoneNameAliases_Request_Body} - Request body type
1919
1934
  */
1920
- export type POST_EmailForwardsBulkDelete_Request = {
1921
- requestBody: EmailForwardBulkDelete;
1935
+ export type POST_EmailForwardsZoneNameAliases_Request = {
1936
+ parameters: {
1937
+ path: operations['create_email_forward_alias_v1_email_forwards__zone_name__aliases_post']['parameters']['path'];
1938
+ };
1939
+ requestBody: EmailForwardAlias;
1922
1940
  }
1923
1941
  /**
1924
- * Request body for POST /v1/email-forwards/bulk-delete
1942
+ * Path parameters for POST /v1/email-forwards/{zone_name}/aliases
1925
1943
  *
1926
1944
  * @remarks
1927
- * This type defines the request body structure for the POST /v1/email-forwards/bulk-delete endpoint.
1945
+ * This type defines the path parameters for the POST /v1/email-forwards/{zone_name}/aliases endpoint.
1946
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1947
+ *
1948
+ * @example
1949
+ * Use this type to ensure type safety for path parameters.
1950
+ *
1951
+ * @path /v1/email-forwards/{zone_name}/aliases
1952
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1953
+ */
1954
+ export type POST_EmailForwardsZoneNameAliases_Request_Path = POST_EmailForwardsZoneNameAliases_Request['parameters']['path'];
1955
+ /**
1956
+ * Request body for POST /v1/email-forwards/{zone_name}/aliases
1957
+ *
1958
+ * @remarks
1959
+ * This type defines the request body structure for the POST /v1/email-forwards/{zone_name}/aliases endpoint.
1928
1960
  * It provides type safety for the request body as defined in the OpenAPI specification.
1929
1961
  *
1930
1962
  * @example
1931
1963
  * Use this type to ensure type safety for request body structure.
1932
1964
  *
1933
- * @path /v1/email-forwards/bulk-delete
1965
+ * @path /v1/email-forwards/{zone_name}/aliases
1934
1966
  */
1935
- export type POST_EmailForwardsBulkDelete_Request_Body = POST_EmailForwardsBulkDelete_Request['requestBody'];
1967
+ export type POST_EmailForwardsZoneNameAliases_Request_Body = POST_EmailForwardsZoneNameAliases_Request['requestBody'];
1936
1968
 
1937
1969
  /**
1938
- * Request type for PATCH EmailForwardsBulkUpdate endpoint
1970
+ * Request type for DELETE EmailForwardsZoneNameAliasesAlias endpoint
1939
1971
  *
1940
- * Bulk Update Email Forwards
1972
+ * Delete Email Forward Alias
1941
1973
  *
1942
1974
  * @remarks
1943
- * This type defines the complete request structure for the PATCH EmailForwardsBulkUpdate endpoint.
1975
+ * This type defines the complete request structure for the DELETE EmailForwardsZoneNameAliasesAlias endpoint.
1944
1976
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1945
1977
  * Use this type to ensure type safety when making API requests to this endpoint.
1946
1978
  *
1947
1979
  * @example
1948
1980
  * Use this type to ensure type safety when making API requests to this endpoint.
1949
1981
  *
1950
- * @path /v1/email-forwards/bulk-update
1982
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
1983
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1951
1984
  *
1952
- * @see {@link PATCH_EmailForwardsBulkUpdate_Request_Query} - Query parameters type
1953
- * @see {@link PATCH_EmailForwardsBulkUpdate_Request_Path} - Path parameters type
1954
- * @see {@link PATCH_EmailForwardsBulkUpdate_Request_Body} - Request body type
1985
+ * @see {@link DELETE_EmailForwardsZoneNameAliasesAlias_Request_Query} - Query parameters type
1986
+ * @see {@link DELETE_EmailForwardsZoneNameAliasesAlias_Request_Path} - Path parameters type
1987
+ * @see {@link DELETE_EmailForwardsZoneNameAliasesAlias_Request_Body} - Request body type
1955
1988
  */
1956
- export type PATCH_EmailForwardsBulkUpdate_Request = {
1957
- requestBody: EmailForwardBulkUpdate;
1989
+ export type DELETE_EmailForwardsZoneNameAliasesAlias_Request = {
1990
+ parameters: {
1991
+ path: operations['delete_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__delete']['parameters']['path'];
1992
+ };
1958
1993
  }
1959
1994
  /**
1960
- * Request body for PATCH /v1/email-forwards/bulk-update
1995
+ * Path parameters for DELETE /v1/email-forwards/{zone_name}/aliases/{alias}
1961
1996
  *
1962
1997
  * @remarks
1963
- * This type defines the request body structure for the PATCH /v1/email-forwards/bulk-update endpoint.
1964
- * It provides type safety for the request body as defined in the OpenAPI specification.
1998
+ * This type defines the path parameters for the DELETE /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
1999
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1965
2000
  *
1966
2001
  * @example
1967
- * Use this type to ensure type safety for request body structure.
2002
+ * Use this type to ensure type safety for path parameters.
1968
2003
  *
1969
- * @path /v1/email-forwards/bulk-update
2004
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2005
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1970
2006
  */
1971
- export type PATCH_EmailForwardsBulkUpdate_Request_Body = PATCH_EmailForwardsBulkUpdate_Request['requestBody'];
2007
+ export type DELETE_EmailForwardsZoneNameAliasesAlias_Request_Path = DELETE_EmailForwardsZoneNameAliasesAlias_Request['parameters']['path'];
1972
2008
 
1973
2009
  /**
1974
- * Request type for DELETE EmailForwardsEmailForwardId endpoint
2010
+ * Request type for GET EmailForwardsZoneNameAliasesAlias endpoint
1975
2011
  *
1976
- * Delete Email Forward
2012
+ * Get Email Forward Alias
1977
2013
  *
1978
2014
  * @remarks
1979
- * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardId endpoint.
2015
+ * This type defines the complete request structure for the GET EmailForwardsZoneNameAliasesAlias endpoint.
1980
2016
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1981
2017
  * Use this type to ensure type safety when making API requests to this endpoint.
1982
2018
  *
1983
2019
  * @example
1984
2020
  * Use this type to ensure type safety when making API requests to this endpoint.
1985
2021
  *
1986
- * @path /v1/email-forwards/{email_forward_id}
2022
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2023
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1987
2024
  *
1988
- * @see {@link DELETE_EmailForwardsEmailForwardId_Request_Query} - Query parameters type
1989
- * @see {@link DELETE_EmailForwardsEmailForwardId_Request_Path} - Path parameters type
1990
- * @see {@link DELETE_EmailForwardsEmailForwardId_Request_Body} - Request body type
2025
+ * @see {@link GET_EmailForwardsZoneNameAliasesAlias_Request_Query} - Query parameters type
2026
+ * @see {@link GET_EmailForwardsZoneNameAliasesAlias_Request_Path} - Path parameters type
2027
+ * @see {@link GET_EmailForwardsZoneNameAliasesAlias_Request_Body} - Request body type
1991
2028
  */
1992
- export type DELETE_EmailForwardsEmailForwardId_Request = {
2029
+ export type GET_EmailForwardsZoneNameAliasesAlias_Request = {
1993
2030
  parameters: {
1994
- path: operations['delete_email_forward_v1_email_forwards__email_forward_id__delete']['parameters']['path'];
2031
+ path: operations['get_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__get']['parameters']['path'];
1995
2032
  };
1996
2033
  }
1997
2034
  /**
1998
- * Path parameters for DELETE /v1/email-forwards/{email_forward_id}
2035
+ * Path parameters for GET /v1/email-forwards/{zone_name}/aliases/{alias}
1999
2036
  *
2000
2037
  * @remarks
2001
- * This type defines the path parameters for the DELETE /v1/email-forwards/{email_forward_id} endpoint.
2038
+ * This type defines the path parameters for the GET /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
2002
2039
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2003
2040
  *
2004
2041
  * @example
2005
2042
  * Use this type to ensure type safety for path parameters.
2006
2043
  *
2007
- * @path /v1/email-forwards/{email_forward_id}
2044
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2045
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
2008
2046
  */
2009
- export type DELETE_EmailForwardsEmailForwardId_Request_Path = DELETE_EmailForwardsEmailForwardId_Request['parameters']['path'];
2047
+ export type GET_EmailForwardsZoneNameAliasesAlias_Request_Path = GET_EmailForwardsZoneNameAliasesAlias_Request['parameters']['path'];
2010
2048
 
2011
2049
  /**
2012
- * Request type for GET EmailForwardsEmailForwardId endpoint
2050
+ * Request type for PUT EmailForwardsZoneNameAliasesAlias endpoint
2013
2051
  *
2014
- * Get Email Forward
2052
+ * Update Email Forward Alias
2015
2053
  *
2016
2054
  * @remarks
2017
- * This type defines the complete request structure for the GET EmailForwardsEmailForwardId endpoint.
2055
+ * This type defines the complete request structure for the PUT EmailForwardsZoneNameAliasesAlias endpoint.
2018
2056
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2019
2057
  * Use this type to ensure type safety when making API requests to this endpoint.
2020
2058
  *
2021
2059
  * @example
2022
2060
  * Use this type to ensure type safety when making API requests to this endpoint.
2023
2061
  *
2024
- * @path /v1/email-forwards/{email_forward_id}
2062
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2063
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
2025
2064
  *
2026
- * @see {@link GET_EmailForwardsEmailForwardId_Request_Query} - Query parameters type
2027
- * @see {@link GET_EmailForwardsEmailForwardId_Request_Path} - Path parameters type
2028
- * @see {@link GET_EmailForwardsEmailForwardId_Request_Body} - Request body type
2065
+ * @see {@link PUT_EmailForwardsZoneNameAliasesAlias_Request_Query} - Query parameters type
2066
+ * @see {@link PUT_EmailForwardsZoneNameAliasesAlias_Request_Path} - Path parameters type
2067
+ * @see {@link PUT_EmailForwardsZoneNameAliasesAlias_Request_Body} - Request body type
2029
2068
  */
2030
- export type GET_EmailForwardsEmailForwardId_Request = {
2069
+ export type PUT_EmailForwardsZoneNameAliasesAlias_Request = {
2031
2070
  parameters: {
2032
- path: operations['get_email_forward_v1_email_forwards__email_forward_id__get']['parameters']['path'];
2071
+ path: operations['update_email_forward_alias_v1_email_forwards__zone_name__aliases__alias__put']['parameters']['path'];
2033
2072
  };
2073
+ requestBody: EmailForwardAliasUpdate;
2034
2074
  }
2035
2075
  /**
2036
- * Path parameters for GET /v1/email-forwards/{email_forward_id}
2076
+ * Path parameters for PUT /v1/email-forwards/{zone_name}/aliases/{alias}
2037
2077
  *
2038
2078
  * @remarks
2039
- * This type defines the path parameters for the GET /v1/email-forwards/{email_forward_id} endpoint.
2079
+ * This type defines the path parameters for the PUT /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
2040
2080
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2041
2081
  *
2042
2082
  * @example
2043
2083
  * Use this type to ensure type safety for path parameters.
2044
2084
  *
2045
- * @path /v1/email-forwards/{email_forward_id}
2085
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2086
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
2046
2087
  */
2047
- export type GET_EmailForwardsEmailForwardId_Request_Path = GET_EmailForwardsEmailForwardId_Request['parameters']['path'];
2088
+ export type PUT_EmailForwardsZoneNameAliasesAlias_Request_Path = PUT_EmailForwardsZoneNameAliasesAlias_Request['parameters']['path'];
2089
+ /**
2090
+ * Request body for PUT /v1/email-forwards/{zone_name}/aliases/{alias}
2091
+ *
2092
+ * @remarks
2093
+ * This type defines the request body structure for the PUT /v1/email-forwards/{zone_name}/aliases/{alias} endpoint.
2094
+ * It provides type safety for the request body as defined in the OpenAPI specification.
2095
+ *
2096
+ * @example
2097
+ * Use this type to ensure type safety for request body structure.
2098
+ *
2099
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
2100
+ */
2101
+ export type PUT_EmailForwardsZoneNameAliasesAlias_Request_Body = PUT_EmailForwardsZoneNameAliasesAlias_Request['requestBody'];
2048
2102
 
2049
2103
  /**
2050
- * Request type for PATCH EmailForwardsEmailForwardId endpoint
2104
+ * Request type for PATCH EmailForwardsZoneNameDisable endpoint
2051
2105
  *
2052
- * Update Email Forward
2106
+ * Disable Email Forward
2053
2107
  *
2054
2108
  * @remarks
2055
- * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardId endpoint.
2109
+ * This type defines the complete request structure for the PATCH EmailForwardsZoneNameDisable endpoint.
2056
2110
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2057
2111
  * Use this type to ensure type safety when making API requests to this endpoint.
2058
2112
  *
2059
2113
  * @example
2060
2114
  * Use this type to ensure type safety when making API requests to this endpoint.
2061
2115
  *
2062
- * @path /v1/email-forwards/{email_forward_id}
2116
+ * @path /v1/email-forwards/{zone_name}/disable
2117
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
2063
2118
  *
2064
- * @see {@link PATCH_EmailForwardsEmailForwardId_Request_Query} - Query parameters type
2065
- * @see {@link PATCH_EmailForwardsEmailForwardId_Request_Path} - Path parameters type
2066
- * @see {@link PATCH_EmailForwardsEmailForwardId_Request_Body} - Request body type
2119
+ * @see {@link PATCH_EmailForwardsZoneNameDisable_Request_Query} - Query parameters type
2120
+ * @see {@link PATCH_EmailForwardsZoneNameDisable_Request_Path} - Path parameters type
2121
+ * @see {@link PATCH_EmailForwardsZoneNameDisable_Request_Body} - Request body type
2067
2122
  */
2068
- export type PATCH_EmailForwardsEmailForwardId_Request = {
2123
+ export type PATCH_EmailForwardsZoneNameDisable_Request = {
2069
2124
  parameters: {
2070
- path: operations['update_email_forward_v1_email_forwards__email_forward_id__patch']['parameters']['path'];
2125
+ path: operations['disable_email_forward_v1_email_forwards__zone_name__disable_patch']['parameters']['path'];
2071
2126
  };
2072
- requestBody: EmailForwardUpdate;
2073
2127
  }
2074
2128
  /**
2075
- * Path parameters for PATCH /v1/email-forwards/{email_forward_id}
2129
+ * Path parameters for PATCH /v1/email-forwards/{zone_name}/disable
2076
2130
  *
2077
2131
  * @remarks
2078
- * This type defines the path parameters for the PATCH /v1/email-forwards/{email_forward_id} endpoint.
2132
+ * This type defines the path parameters for the PATCH /v1/email-forwards/{zone_name}/disable endpoint.
2079
2133
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2080
2134
  *
2081
2135
  * @example
2082
2136
  * Use this type to ensure type safety for path parameters.
2083
2137
  *
2084
- * @path /v1/email-forwards/{email_forward_id}
2138
+ * @path /v1/email-forwards/{zone_name}/disable
2139
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
2085
2140
  */
2086
- export type PATCH_EmailForwardsEmailForwardId_Request_Path = PATCH_EmailForwardsEmailForwardId_Request['parameters']['path'];
2141
+ export type PATCH_EmailForwardsZoneNameDisable_Request_Path = PATCH_EmailForwardsZoneNameDisable_Request['parameters']['path'];
2142
+
2087
2143
  /**
2088
- * Request body for PATCH /v1/email-forwards/{email_forward_id}
2144
+ * Request type for PATCH EmailForwardsZoneNameEnable endpoint
2145
+ *
2146
+ * Enable Email Forward
2089
2147
  *
2090
2148
  * @remarks
2091
- * This type defines the request body structure for the PATCH /v1/email-forwards/{email_forward_id} endpoint.
2092
- * It provides type safety for the request body as defined in the OpenAPI specification.
2149
+ * This type defines the complete request structure for the PATCH EmailForwardsZoneNameEnable endpoint.
2150
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2151
+ * Use this type to ensure type safety when making API requests to this endpoint.
2093
2152
  *
2094
2153
  * @example
2095
- * Use this type to ensure type safety for request body structure.
2154
+ * Use this type to ensure type safety when making API requests to this endpoint.
2155
+ *
2156
+ * @path /v1/email-forwards/{zone_name}/enable
2157
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
2158
+ *
2159
+ * @see {@link PATCH_EmailForwardsZoneNameEnable_Request_Query} - Query parameters type
2160
+ * @see {@link PATCH_EmailForwardsZoneNameEnable_Request_Path} - Path parameters type
2161
+ * @see {@link PATCH_EmailForwardsZoneNameEnable_Request_Body} - Request body type
2162
+ */
2163
+ export type PATCH_EmailForwardsZoneNameEnable_Request = {
2164
+ parameters: {
2165
+ path: operations['enable_email_forward_v1_email_forwards__zone_name__enable_patch']['parameters']['path'];
2166
+ };
2167
+ }
2168
+ /**
2169
+ * Path parameters for PATCH /v1/email-forwards/{zone_name}/enable
2170
+ *
2171
+ * @remarks
2172
+ * This type defines the path parameters for the PATCH /v1/email-forwards/{zone_name}/enable endpoint.
2173
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
2096
2174
  *
2097
- * @path /v1/email-forwards/{email_forward_id}
2175
+ * @example
2176
+ * Use this type to ensure type safety for path parameters.
2177
+ *
2178
+ * @path /v1/email-forwards/{zone_name}/enable
2179
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
2098
2180
  */
2099
- export type PATCH_EmailForwardsEmailForwardId_Request_Body = PATCH_EmailForwardsEmailForwardId_Request['requestBody'];
2181
+ export type PATCH_EmailForwardsZoneNameEnable_Request_Path = PATCH_EmailForwardsZoneNameEnable_Request['parameters']['path'];
2100
2182
 
2101
2183
  /**
2102
2184
  * Request type for GET Event endpoint