@opusdns/api 0.28.0 → 0.30.0

package/src/openapi.yaml

@@ -23,6 +23,24 @@ components:
       - max
       title: AllowedNumberOfNameserverBase
       type: object
+    BillingTransactionAction:
+      enum:
+      - create
+      - transfer
+      - renew
+      - restore
+      - trade
+      - application
+      title: BillingTransactionAction
+      type: string
+    BillingTransactionProductType:
+      enum:
+      - domain
+      - zone
+      - email_forward
+      - domain_forward
+      title: BillingTransactionProductType
+      type: string
     Body_issue_organization_token_v1_auth_token_post:
       properties:
         client_id:
@@ -2085,6 +2103,35 @@ components:
       - start_date
       title: GeneralAvailabilityBase
       type: object
+    GetCurrentAvailablePlansResponse:
+      properties:
+        current_plan:
+          anyOf:
+          - $ref: '#/components/schemas/PlanInfo'
+          - type: 'null'
+          description: Current active plan for the customer
+        plans:
+          description: List of available plans
+          items:
+            $ref: '#/components/schemas/PlanInfo'
+          title: Plans
+          type: array
+      required:
+      - plans
+      title: GetCurrentAvailablePlansResponse
+      type: object
+    GetPricesResponse:
+      properties:
+        prices:
+          description: List of prices
+          items:
+            $ref: '#/components/schemas/PriceInfo'
+          title: Prices
+          type: array
+      required:
+      - prices
+      title: GetPricesResponse
+      type: object
     GrantType:
       enum:
       - client_credentials
@@ -3582,6 +3629,44 @@ components:
           type: array
       title: PermissionSet
       type: object
+    PlanInfo:
+      properties:
+        amount:
+          description: Base price
+          title: Amount
+          type: number
+        currency:
+          description: Currency code
+          title: Currency
+          type: string
+        name:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Plan display name
+          title: Name
+        plan_id:
+          description: Unique plan identifier
+          title: Plan Id
+          type: string
+        plan_level:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Plan level such as 'premium' or 'starter'
+          title: Plan Level
+        plan_type:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Plan type or billing interval
+          title: Plan Type
+      required:
+      - plan_id
+      - currency
+      - amount
+      title: PlanInfo
+      type: object
     PlanRelation:
       enum:
       - basic_plan
@@ -3646,6 +3731,33 @@ components:
       - manual
       title: PremiumSourceType
       type: string
+    PriceInfo:
+      properties:
+        currency:
+          title: Currency
+          type: string
+        price:
+          title: Price
+          type: string
+        product_action:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Product Action
+        product_class:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Product Class
+        product_type:
+          title: Product Type
+          type: string
+      required:
+      - product_type
+      - price
+      - currency
+      title: PriceInfo
+      type: object
     Problem:
       properties:
         detail:
@@ -4798,7 +4910,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-08-29-171808
+  version: 2025-09-03-232034
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7144,6 +7256,102 @@ paths:
       summary: Update DNSSEC data
       tags:
       - domain
+  /v1/domains/{domain_reference}/dnssec/disable:
+    post:
+      operationId: disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post
+      parameters:
+      - in: path
+        name: domain_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: domain
+          - type: string
+          title: Domain Reference
+      responses:
+        '204':
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_NOT_FOUND
+                detail: Domain not found
+                domain_name: Additional error context.
+                status: 404
+                title: Domain Management Error
+                type: domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Disable DNSSEC for domains using our nameservers
+      tags:
+      - domain
+  /v1/domains/{domain_reference}/dnssec/enable:
+    post:
+      operationId: enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post
+      parameters:
+      - in: path
+        name: domain_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: domain
+          - type: string
+          title: Domain Reference
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/DomainDnssecDataResponse'
+                title: Response Enable And Publish Dnssec Records V1 Domains  Domain
+                  Reference  Dnssec Enable Post
+                type: array
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_NOT_FOUND
+                detail: Domain not found
+                domain_name: Additional error context.
+                status: 404
+                title: Domain Management Error
+                type: domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Enable DNSSEC for domains using our nameservers
+      tags:
+      - domain
   /v1/domains/{domain_reference}/renew:
     post:
       description: 'Extends the registration period of an existing domain. The renewal
@@ -8475,6 +8683,93 @@ paths:
       summary: Change Plan
       tags:
       - organization
+  /v1/organizations/{organization_id}/plans:
+    get:
+      operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
+      parameters:
+      - in: path
+        name: organization_id
+        required: true
+        schema:
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetCurrentAvailablePlansResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get Current Available Plans
+      tags:
+      - organization
+  /v1/organizations/{organization_id}/pricing/product-type/{product_type}:
+    get:
+      operationId: get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get
+      parameters:
+      - in: path
+        name: organization_id
+        required: true
+        schema:
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+      - in: path
+        name: product_type
+        required: true
+        schema:
+          $ref: '#/components/schemas/BillingTransactionProductType'
+      - in: query
+        name: product_action
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/BillingTransactionAction'
+          - type: 'null'
+          title: Product Action
+      - in: query
+        name: product_class
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Product Class
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetPricesResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get Pricing Plans
+      tags:
+      - organization
   /v1/tlds/portfolio:
     get:
       operationId: get_tld_portfolio_v1_tlds_portfolio_get

package/src/schema.d.ts

@@ -545,6 +545,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/domains/{domain_reference}/dnssec/disable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Disable DNSSEC for domains using our nameservers */
+        post: operations["disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/domains/{domain_reference}/dnssec/enable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Enable DNSSEC for domains using our nameservers */
+        post: operations["enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/domains/{domain_reference}/renew": {
         parameters: {
             query?: never;
@@ -923,6 +957,40 @@ export interface paths {
         patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
         trace?: never;
     };
+    "/v1/organizations/{organization_id}/plans": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Current Available Plans */
+        get: operations["get_current_available_plans_v1_organizations__organization_id__plans_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/organizations/{organization_id}/pricing/product-type/{product_type}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get Pricing Plans */
+        get: operations["get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/tlds/portfolio": {
         parameters: {
             query?: never;
@@ -1067,6 +1135,16 @@ export interface components {
              */
             min: number;
         };
+        /**
+         * BillingTransactionAction
+         * @enum {string}
+         */
+        BillingTransactionAction: "create" | "transfer" | "renew" | "restore" | "trade" | "application";
+        /**
+         * BillingTransactionProductType
+         * @enum {string}
+         */
+        BillingTransactionProductType: "domain" | "zone" | "email_forward" | "domain_forward";
         /** Body_issue_organization_token_v1_auth_token_post */
         Body_issue_organization_token_v1_auth_token_post: {
             /**
@@ -2404,6 +2482,24 @@ export interface components {
              */
             start_date: Date;
         };
+        /** GetCurrentAvailablePlansResponse */
+        GetCurrentAvailablePlansResponse: {
+            /** @description Current active plan for the customer */
+            current_plan?: components["schemas"]["PlanInfo"] | null;
+            /**
+             * Plans
+             * @description List of available plans
+             */
+            plans: components["schemas"]["PlanInfo"][];
+        };
+        /** GetPricesResponse */
+        GetPricesResponse: {
+            /**
+             * Prices
+             * @description List of prices
+             */
+            prices: components["schemas"]["PriceInfo"][];
+        };
         /**
          * GrantType
          * @enum {string}
@@ -3419,6 +3515,39 @@ export interface components {
             /** Permissions */
             permissions?: components["schemas"]["Permission"][];
         };
+        /** PlanInfo */
+        PlanInfo: {
+            /**
+             * Amount
+             * @description Base price
+             */
+            amount: number;
+            /**
+             * Currency
+             * @description Currency code
+             */
+            currency: string;
+            /**
+             * Name
+             * @description Plan display name
+             */
+            name?: string | null;
+            /**
+             * Plan Id
+             * @description Unique plan identifier
+             */
+            plan_id: string;
+            /**
+             * Plan Level
+             * @description Plan level such as 'premium' or 'starter'
+             */
+            plan_level?: string | null;
+            /**
+             * Plan Type
+             * @description Plan type or billing interval
+             */
+            plan_type?: string | null;
+        };
         /**
          * PlanRelation
          * @enum {string}
@@ -3464,6 +3593,19 @@ export interface components {
          * @enum {string}
          */
         PremiumSourceType: "EPP" | "API" | "CSV" | "manual";
+        /** PriceInfo */
+        PriceInfo: {
+            /** Currency */
+            currency: string;
+            /** Price */
+            price: string;
+            /** Product Action */
+            product_action?: string | null;
+            /** Product Class */
+            product_class?: string | null;
+            /** Product Type */
+            product_type: string;
+        };
         /** Problem */
         Problem: {
             /** Problem detail */
@@ -6288,6 +6430,100 @@ export interface operations {
             };
         };
     };
+    disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                domain_reference: TypeID<"domain"> | string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_DOMAIN_NOT_FOUND",
+                     *       "detail": "Domain not found",
+                     *       "domain_name": "Additional error context.",
+                     *       "status": 404,
+                     *       "title": "Domain Management Error",
+                     *       "type": "domain-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                domain_reference: TypeID<"domain"> | string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DomainDnssecDataResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_DOMAIN_NOT_FOUND",
+                     *       "detail": "Domain not found",
+                     *       "domain_name": "Additional error context.",
+                     *       "status": 404,
+                     *       "title": "Domain Management Error",
+                     *       "type": "domain-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     renew_domain_v1_domains__domain_reference__renew_post: {
         parameters: {
             query?: never;
@@ -7547,6 +7783,72 @@ export interface operations {
             };
         };
     };
+    get_current_available_plans_v1_organizations__organization_id__plans_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                organization_id: TypeID<"organization">;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetCurrentAvailablePlansResponse"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get: {
+        parameters: {
+            query?: {
+                product_action?: components["schemas"]["BillingTransactionAction"] | null;
+                product_class?: string | null;
+            };
+            header?: never;
+            path: {
+                organization_id: TypeID<"organization">;
+                product_type: components["schemas"]["BillingTransactionProductType"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetPricesResponse"];
+                };
+            };
+            /** @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;