@opusdns/api 0.86.0 → 0.88.0

package/src/schema.d.ts

@@ -282,7 +282,7 @@ export interface paths {
         patch: operations["patch_zone_rrsets_v1_dns__zone_name__rrsets_patch"];
         trace?: never;
     };
-    "/v1/domain-forwards": {
+    "/v1/domain-forwards/{zone_name}/disable": {
         parameters: {
             query?: never;
             header?: never;
@@ -295,31 +295,11 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        /** Patch Redirects */
-        patch: operations["patch_redirects_v1_domain_forwards_patch"];
-        trace?: never;
-    };
-    "/v1/domain-forwards/{zone_name}": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /** Get Redirects */
-        get: operations["get_redirects_v1_domain_forwards__zone_name__get"];
-        /** Update Redirects */
-        put: operations["update_redirects_v1_domain_forwards__zone_name__put"];
-        /** Create Redirects */
-        post: operations["create_redirects_v1_domain_forwards__zone_name__post"];
-        /** Delete Redirects */
-        delete: operations["delete_redirects_v1_domain_forwards__zone_name__delete"];
-        options?: never;
-        head?: never;
-        patch?: never;
+        /** Disable Domain Forward */
+        patch: operations["disable_domain_forward_v1_domain_forwards__zone_name__disable_patch"];
         trace?: never;
     };
-    "/v1/domain-forwards/{zone_name}/disable": {
+    "/v1/domain-forwards/{zone_name}/enable": {
         parameters: {
             query?: never;
             header?: never;
@@ -332,25 +312,28 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        /** Disable Domain Forward */
-        patch: operations["disable_domain_forward_v1_domain_forwards__zone_name__disable_patch"];
+        /** Enable Domain Forward */
+        patch: operations["enable_domain_forward_v1_domain_forwards__zone_name__enable_patch"];
         trace?: never;
     };
-    "/v1/domain-forwards/{zone_name}/enable": {
+    "/v1/domain-forwards/{zone_name}/{request_protocol}": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get?: never;
-        put?: never;
-        post?: never;
-        delete?: never;
+        /** Get Domain Forward */
+        get: operations["get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get"];
+        /** Update Domain Forward */
+        put: operations["update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put"];
+        /** Create Domain Forward */
+        post: operations["create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post"];
+        /** Delete Domain Forward */
+        delete: operations["delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete"];
         options?: never;
         head?: never;
-        /** Enable Domain Forward */
-        patch: operations["enable_domain_forward_v1_domain_forwards__zone_name__enable_patch"];
+        patch?: never;
         trace?: never;
     };
     "/v1/domain-search/suggest": {
@@ -989,6 +972,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/tlds/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get list of Specifications for all TLDs we support
+         * @description Retrieves a list of TLD Specifications we have support for
+         */
+        get: operations["get_tld_specifications_v1_tlds__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/tlds/portfolio": {
         parameters: {
             query?: never;
@@ -2228,6 +2231,33 @@ export interface components {
              */
             updated_on?: Date;
         };
+        /** DomainForward */
+        DomainForward: {
+            /**
+             * Created On
+             * Format: date-time
+             */
+            created_on: Date;
+            /** Redirects */
+            redirects: components["schemas"]["HttpRedirect"][];
+            request_protocol: components["schemas"]["HttpProtocol"];
+            /**
+             * Updated On
+             * Format: date-time
+             */
+            updated_on: Date;
+            /** Wildcard */
+            wildcard: boolean;
+            /** Zone Name */
+            zone_name: string;
+        };
+        /** DomainForwardRequest */
+        DomainForwardRequest: {
+            /** Redirects */
+            redirects: components["schemas"]["HttpRedirect"][];
+            /** Wildcard */
+            wildcard: boolean;
+        };
         /** DomainLifecycleBase */
         DomainLifecycleBase: {
             /**
@@ -2844,6 +2874,26 @@ export interface components {
             /** Problem type */
             type: string;
         };
+        /**
+         * HttpProtocol
+         * @enum {string}
+         */
+        HttpProtocol: "http" | "https";
+        /** HttpRedirect */
+        HttpRedirect: {
+            redirect_code: components["schemas"]["RedirectCode"];
+            /** Request Path */
+            request_path: string;
+            /** Request Subdomain */
+            request_subdomain?: string | null;
+            /** Target Domain */
+            target_domain: string;
+            /** Target Path */
+            target_path: string;
+            target_protocol: components["schemas"]["HttpProtocol"];
+            /** Target Subdomain */
+            target_subdomain?: string | null;
+        };
         /** IdnBase */
         IdnBase: {
             /**
@@ -3547,12 +3597,6 @@ export interface components {
             /** Results */
             results: components["schemas"]["Organization"][];
         };
-        /** Pagination[Redirect] */
-        Pagination_Redirect_: {
-            pagination: components["schemas"]["PaginationMetadata"];
-            /** Results */
-            results: components["schemas"]["Redirect"][];
-        };
         /** Pagination[User] */
         Pagination_User_: {
             pagination: components["schemas"]["PaginationMetadata"];
@@ -3697,73 +3741,11 @@ export interface components {
              */
             rdap_server?: string | null;
         };
-        /** Redirect */
-        Redirect: {
-            /** Redirect Code */
-            redirect_code: number;
-            /** Request Domain */
-            request_domain: string;
-            /** Request Path */
-            request_path: string;
-            /** Request Protocol */
-            request_protocol: string;
-            /** Request Subdomain */
-            request_subdomain: string;
-            /** Target Domain */
-            target_domain: string;
-            /** Target Path */
-            target_path: string;
-            /** Target Protocol */
-            target_protocol: string;
-            /** Target Subdomain */
-            target_subdomain: string;
-        };
-        /** RedirectPatchOp */
-        RedirectPatchOp: {
-            op: components["schemas"]["PatchOp"];
-            /** Redirect */
-            redirect: components["schemas"]["Redirect"] | components["schemas"]["RedirectRemove"];
-        };
-        /** RedirectPatchOps */
-        RedirectPatchOps: {
-            /** Ops */
-            ops: components["schemas"]["RedirectPatchOp"][];
-        };
-        /** RedirectRemove */
-        RedirectRemove: {
-            /** Request Domain */
-            request_domain: string;
-            /** Request Path */
-            request_path: string;
-            /** Request Protocol */
-            request_protocol: string;
-            /** Request Subdomain */
-            request_subdomain: string;
-        };
-        /** RedirectSet */
-        RedirectSet: {
-            /** Redirects */
-            redirects: components["schemas"]["RedirectUpdate"][];
-        };
-        /** RedirectUpdate */
-        RedirectUpdate: {
-            /** Redirect Code */
-            redirect_code: number;
-            /** Request Path */
-            request_path: string;
-            /** Request Protocol */
-            request_protocol: string;
-            /** Request Subdomain */
-            request_subdomain: string;
-            /** Target Domain */
-            target_domain: string;
-            /** Target Path */
-            target_path: string;
-            /** Target Protocol */
-            target_protocol: string;
-            /** Target Subdomain */
-            target_subdomain: string;
-        };
+        /**
+         * RedirectCode
+         * @enum {integer}
+         */
+        RedirectCode: 301 | 302 | 307 | 308;
         /**
          * RegistrantChangeType
          * @enum {string}
@@ -5701,18 +5683,17 @@ export interface operations {
             };
         };
     };
-    patch_redirects_v1_domain_forwards_patch: {
+    disable_domain_forward_v1_domain_forwards__zone_name__disable_patch: {
         parameters: {
             query?: never;
             header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["RedirectPatchOps"];
+            path: {
+                /** @description DNS zone name (trailing dot optional) */
+                zone_name: string;
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Successful Response */
             204: {
@@ -5732,11 +5713,10 @@ export interface operations {
             };
         };
     };
-    get_redirects_v1_domain_forwards__zone_name__get: {
+    enable_domain_forward_v1_domain_forwards__zone_name__enable_patch: {
         parameters: {
             query?: {
-                page?: number;
-                page_size?: number;
+                auto_create_zone?: boolean;
             };
             header?: never;
             path: {
@@ -5748,13 +5728,11 @@ export interface operations {
         requestBody?: never;
         responses: {
             /** @description Successful Response */
-            200: {
+            204: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content: {
-                    "application/json": components["schemas"]["Pagination_Redirect_"];
-                };
+                content?: never;
             };
             /** @description Validation Error */
             422: {
@@ -5767,43 +5745,26 @@ export interface operations {
             };
         };
     };
-    update_redirects_v1_domain_forwards__zone_name__put: {
+    get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get: {
         parameters: {
             query?: never;
             header?: never;
             path: {
+                request_protocol: components["schemas"]["HttpProtocol"];
                 /** @description DNS zone name (trailing dot optional) */
                 zone_name: string;
             };
             cookie?: never;
         };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["RedirectSet"];
-            };
-        };
+        requestBody?: never;
         responses: {
             /** @description Successful Response */
-            204: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Conflict */
-            409: {
+            200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    /** @example {
-                     *       "code": "ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS",
-                     *       "detail": "Redirect does not exist for A, d, d, i, t, i, o, n, a, l,  , e, r, r, o, r,  , c, o, n, t, e, x, t, .",
-                     *       "status": 409,
-                     *       "title": "Domain Forward Error",
-                     *       "type": "domain-forward-redirect-not-exists"
-                     *     } */
-                    "application/problem+json": components["schemas"]["Problem"];
+                    "application/json": components["schemas"]["DomainForward"];
                 };
             };
             /** @description Validation Error */
@@ -5817,11 +5778,12 @@ export interface operations {
             };
         };
     };
-    create_redirects_v1_domain_forwards__zone_name__post: {
+    update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put: {
         parameters: {
             query?: never;
             header?: never;
             path: {
+                request_protocol: components["schemas"]["HttpProtocol"];
                 /** @description DNS zone name (trailing dot optional) */
                 zone_name: string;
             };
@@ -5829,16 +5791,18 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["RedirectSet"];
+                "application/json": components["schemas"]["DomainForwardRequest"];
             };
         };
         responses: {
             /** @description Successful Response */
-            201: {
+            200: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["DomainForward"];
+                };
             };
             /** @description Conflict */
             409: {
@@ -5847,11 +5811,11 @@ export interface operations {
                 };
                 content: {
                     /** @example {
-                     *       "code": "ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS",
-                     *       "detail": "Redirect already exists for A, d, d, i, t, i, o, n, a, l,  , e, r, r, o, r,  , c, o, n, t, e, x, t, .",
+                     *       "code": "ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS",
+                     *       "detail": "Redirect does not exist for A, d, d, i, t, i, o, n, a, l,  , e, r, r, o, r,  , c, o, n, t, e, x, t, .",
                      *       "status": 409,
                      *       "title": "Domain Forward Error",
-                     *       "type": "domain-forward-redirect-already-exists"
+                     *       "type": "domain-forward-redirect-not-exists"
                      *     } */
                     "application/problem+json": components["schemas"]["Problem"];
                 };
@@ -5867,54 +5831,47 @@ export interface operations {
             };
         };
     };
-    delete_redirects_v1_domain_forwards__zone_name__delete: {
+    create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post: {
         parameters: {
             query?: never;
             header?: never;
             path: {
+                request_protocol: components["schemas"]["HttpProtocol"];
                 /** @description DNS zone name (trailing dot optional) */
                 zone_name: string;
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DomainForwardRequest"];
+            };
+        };
         responses: {
             /** @description Successful Response */
-            204: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Validation Error */
-            422: {
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                    "application/json": components["schemas"]["DomainForward"];
                 };
             };
-        };
-    };
-    disable_domain_forward_v1_domain_forwards__zone_name__disable_patch: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                /** @description DNS zone name (trailing dot optional) */
-                zone_name: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            204: {
+            /** @description Conflict */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS",
+                     *       "detail": "Redirect already exists for A, d, d, i, t, i, o, n, a, l,  , e, r, r, o, r,  , c, o, n, t, e, x, t, .",
+                     *       "status": 409,
+                     *       "title": "Domain Forward Error",
+                     *       "type": "domain-forward-redirect-already-exists"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
             };
             /** @description Validation Error */
             422: {
@@ -5927,13 +5884,12 @@ export interface operations {
             };
         };
     };
-    enable_domain_forward_v1_domain_forwards__zone_name__enable_patch: {
+    delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete: {
         parameters: {
-            query?: {
-                auto_create_zone?: boolean;
-            };
+            query?: never;
             header?: never;
             path: {
+                request_protocol: components["schemas"]["HttpProtocol"];
                 /** @description DNS zone name (trailing dot optional) */
                 zone_name: string;
             };
@@ -8494,6 +8450,40 @@ export interface operations {
             };
         };
     };
+    get_tld_specifications_v1_tlds__get: {
+        parameters: {
+            query?: {
+                fields?: string | null;
+                tlds?: string | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: Record<string, never>[];
+                    };
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_tld_portfolio_v1_tlds_portfolio_get: {
         parameters: {
             query?: never;