@opusdns/api 0.138.0 → 0.140.0

package/src/schema.d.ts

@@ -504,11 +504,10 @@ export interface paths {
         get: operations["get_domain_forward_v1_domain_forwards__hostname__get"];
         put?: never;
         /**
-         * Create a domain forward (deprecated)
-         * @deprecated
-         * @description **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
+         * Create domain forward set
+         * @description Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
          */
-        post: operations["create_domain_forward_v1_domain_forwards__hostname__post"];
+        post: operations["create_domain_forward_set_v1_domain_forwards__hostname__post"];
         /**
          * Delete a domain forward
          * @description Deletes the domain forward configuration for the specified hostname
@@ -577,10 +576,11 @@ export interface paths {
          */
         put: operations["update_domain_forward_set_v1_domain_forwards__hostname___protocol__put"];
         /**
-         * Create domain forward set
-         * @description Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
+         * Create domain forward set (deprecated)
+         * @deprecated
+         * @description Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
          */
-        post: operations["create_domain_forward_set_v1_domain_forwards__hostname___protocol__post"];
+        post: operations["create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post"];
         /**
          * Delete domain forward set
          * @description Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
@@ -2658,8 +2658,6 @@ export interface components {
              * Format: date-time
              */
             updated_on: Date;
-            /** Wildcard */
-            wildcard: boolean;
         };
         /** DomainForwardCreateRequest */
         DomainForwardCreateRequest: {
@@ -2688,8 +2686,6 @@ export interface components {
         DomainForwardProtocolSetRequest: {
             /** Redirects */
             redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
-            /** Wildcard */
-            wildcard?: boolean | null;
         };
         /** DomainForwardProtocolSetResponse */
         DomainForwardProtocolSetResponse: {
@@ -2705,20 +2701,12 @@ export interface components {
              * Format: date-time
              */
             updated_on: Date;
-            /** Wildcard */
-            wildcard: boolean;
         };
-        /** DomainForwardRequest */
-        DomainForwardRequest: {
-            /**
-             * Enabled
-             * @default false
-             */
-            enabled: boolean;
-            http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
-            https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
-            /** Wildcard */
-            wildcard?: boolean | null;
+        /** DomainForwardSetCreateRequest */
+        DomainForwardSetCreateRequest: {
+            protocol: components["schemas"]["HttpProtocol"];
+            /** Redirects */
+            redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
         };
         /** DomainForwardSetRequest */
         DomainForwardSetRequest: {
@@ -2742,8 +2730,6 @@ export interface components {
              * Format: date-time
              */
             updated_on: Date;
-            /** Wildcard */
-            wildcard: boolean;
         };
         /**
          * DomainForwardSortField
@@ -4644,11 +4630,11 @@ export interface components {
             /** Results */
             results: components["schemas"]["RequestHistory"][];
         };
-        /** Pagination[User] */
-        Pagination_User_: {
+        /** Pagination[UserPublic] */
+        Pagination_UserPublic_: {
             pagination: components["schemas"]["PaginationMetadata"];
             /** Results */
-            results: components["schemas"]["User"][];
+            results: components["schemas"]["UserPublic"][];
         };
         /** PasswordUpdate */
         PasswordUpdate: {
@@ -5207,6 +5193,11 @@ export interface components {
              * @description The user's first name
              */
             first_name: string;
+            /**
+             * Keycloak User Id
+             * @description Keycloak user id
+             */
+            keycloak_user_id?: string | null;
             /**
              * Last Name
              * @description The user's last name
@@ -5316,67 +5307,75 @@ export interface components {
              */
             username: string;
         };
-        /**
-         * UserStatus
-         * @enum {string}
-         */
-        UserStatus: "active" | "inactive";
-        /** UserTokenResponse */
-        UserTokenResponse: {
-            /** Access Token */
-            access_token: string;
-            /** Expires In */
-            expires_in: number;
-            /** Refresh Expires In */
-            refresh_expires_in: number;
-            /** Refresh Token */
-            refresh_token: string;
+        /** UserPublic */
+        UserPublic: {
             /**
-             * Token Type
-             * @default Bearer
+             * Created On
+             * Format: date-time
+             * @description The date/time the entry was created on
              */
-            token_type: string;
-        };
-        /** UserUpdate */
-        UserUpdate: {
+            created_on?: Date;
+            /**
+             * Deleted On
+             * @description The date/time the entry was deleted on
+             */
+            deleted_on?: Date | null;
             /**
              * Email
+             * Format: email
              * @description The user's email address
              */
-            email?: string | null;
+            email: string;
             /**
              * First Name
              * @description The user's first name
              */
-            first_name?: string | null;
+            first_name: string;
             /**
              * Last Name
              * @description The user's last name
              */
-            last_name?: string | null;
+            last_name: string;
             /**
              * Locale
-             * @description The user's locale
+             * @example en_US
              */
-            locale?: string | null;
+            locale: string;
+            /**
+             * Organization Id
+             * Format: typeid
+             * @description The user's organization id
+             * @default None
+             * @example organization_01h45ytscbebyvny4gc8cr8ma2
+             */
+            organization_id: TypeId<"organization">;
             /**
              * Phone
              * @description The user's phone number
+             * @example +1.2125552368
              */
             phone?: string | null;
+            readonly status: components["schemas"]["UserStatus"];
             /**
-             * User Attributes
-             * @description User attributes
+             * Updated On
+             * Format: date-time
+             * @description The date/time the entry was last updated on
              */
-            user_attributes?: components["schemas"]["UserAttributeBase"][] | null;
+            updated_on?: Date;
+            /**
+             * User Id
+             * Format: typeid
+             * @example user_01h45ytscbebyvny4gc8cr8ma2
+             */
+            user_id?: TypeId<"user">;
             /**
              * Username
              * @description The user's unique username
              */
-            username?: string | null;
+            username: string;
         };
-        /** UserWithAttributes */
-        UserWithAttributes: {
+        /** UserPublicWithAttributes */
+        UserPublicWithAttributes: {
             /**
              * Created On
              * Format: date-time
@@ -5459,6 +5458,65 @@ export interface components {
              */
             username: string;
         };
+        /**
+         * UserStatus
+         * @enum {string}
+         */
+        UserStatus: "active" | "inactive";
+        /** UserTokenResponse */
+        UserTokenResponse: {
+            /** Access Token */
+            access_token: string;
+            /** Expires In */
+            expires_in: number;
+            /** Refresh Expires In */
+            refresh_expires_in: number;
+            /** Refresh Token */
+            refresh_token: string;
+            /**
+             * Token Type
+             * @default Bearer
+             */
+            token_type: string;
+        };
+        /** UserUpdate */
+        UserUpdate: {
+            /**
+             * Email
+             * @description The user's email address
+             */
+            email?: string | null;
+            /**
+             * First Name
+             * @description The user's first name
+             */
+            first_name?: string | null;
+            /**
+             * Last Name
+             * @description The user's last name
+             */
+            last_name?: string | null;
+            /**
+             * Locale
+             * @description The user's locale
+             */
+            locale?: string | null;
+            /**
+             * Phone
+             * @description The user's phone number
+             */
+            phone?: string | null;
+            /**
+             * User Attributes
+             * @description User attributes
+             */
+            user_attributes?: components["schemas"]["UserAttributeBase"][] | null;
+            /**
+             * Username
+             * @description The user's unique username
+             */
+            username?: string | null;
+        };
         /** UserWithRelationPermissions */
         UserWithRelationPermissions: {
             /**
@@ -7742,7 +7800,7 @@ export interface operations {
             };
         };
     };
-    create_domain_forward_v1_domain_forwards__hostname__post: {
+    create_domain_forward_set_v1_domain_forwards__hostname__post: {
         parameters: {
             query?: never;
             header?: never;
@@ -7754,17 +7812,17 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["DomainForwardRequest"];
+                "application/json": components["schemas"]["DomainForwardSetCreateRequest"];
             };
         };
         responses: {
-            /** @description Domain forward created successfully */
+            /** @description Successful Response */
             201: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["DomainForward"];
+                    "application/json": components["schemas"]["DomainForwardSetResponse"];
                 };
             };
             /** @description Unauthorized */
@@ -7799,24 +7857,23 @@ export interface operations {
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
-            /** @description DNS zone was not found */
+            /** @description Not Found */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     /** @example {
-                     *       "code": "ERROR_ZONE_NOT_FOUND",
-                     *       "detail": "Zone not found",
+                     *       "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
+                     *       "detail": "Domain forward not found for Additional error context.",
                      *       "status": 404,
-                     *       "title": "DNS Error",
-                     *       "type": "dns-zone-not-found",
-                     *       "zone_name": "Zone example.com. not found"
+                     *       "title": "Domain Forward Error",
+                     *       "type": "domain-forward-not-found"
                      *     } */
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
-            /** @description Domain forward already exists */
+            /** @description Conflict */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -7824,7 +7881,7 @@ export interface operations {
                 content: {
                     /** @example {
                      *       "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
-                     *       "detail": "Domain forward already exists for example.com.",
+                     *       "detail": "Domain forward already exists for Additional error context.",
                      *       "status": 409,
                      *       "title": "Domain Forward Error",
                      *       "type": "domain-forward-already-exists"
@@ -8227,7 +8284,7 @@ export interface operations {
             };
         };
     };
-    create_domain_forward_set_v1_domain_forwards__hostname___protocol__post: {
+    create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post: {
         parameters: {
             query?: never;
             header?: never;
@@ -11221,7 +11278,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["Pagination_User_"];
+                    "application/json": components["schemas"]["Pagination_UserPublic_"];
                 };
             };
             /** @description Unauthorized */
@@ -11830,7 +11887,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["User"];
+                    "application/json": components["schemas"]["UserPublic"];
                 };
             };
             /** @description Validation Error */
@@ -11941,7 +11998,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["UserWithAttributes"];
+                    "application/json": components["schemas"]["UserPublicWithAttributes"];
                 };
             };
             /** @description Validation Error */
@@ -12021,7 +12078,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["UserWithAttributes"];
+                    "application/json": components["schemas"]["UserPublicWithAttributes"];
                 };
             };
             /** @description Validation Error */