@opusdns/api 0.33.0 → 0.34.0

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET AuthClientCredentials endpoint
@@ -4439,9 +4439,9 @@ export type GET_OrganizationsByOrganizationId_Response = GET_OrganizationsByOrga
  * @path /v1/organizations/{organization_id}
  *
  * @see {@link GET_OrganizationsByOrganizationId_Response} - The main response type definition
- * @see {@link OrganizationWithPlan} - The actual schema type definition
+ * @see {@link OrganizationWithBillingData} - The actual schema type definition
  */
-export type GET_OrganizationsByOrganizationId_Response_200 = OrganizationWithPlan
+export type GET_OrganizationsByOrganizationId_Response_200 = OrganizationWithBillingData
 
 /**
  * 422 response for GET OrganizationsByOrganizationId endpoint
@@ -4549,9 +4549,9 @@ export type PATCH_OrganizationsByOrganizationIdPlan_Response = PATCH_Organizatio
  * @path /v1/organizations/{organization_id}/plan
  *
  * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
- * @see {@link OrganizationWithPlan} - The actual schema type definition
+ * @see {@link OrganizationWithBillingData} - The actual schema type definition
  */
-export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationWithPlan
+export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationWithBillingData
 
 /**
  * 422 response for PATCH OrganizationsByOrganizationIdPlan endpoint

package/src/helpers/schemas.d.ts

@@ -58,6 +58,38 @@ export type AllocationMethodType = components['schemas']['AllocationMethodType']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumberOfNameserverBase'];
+/**
+ * BillingMetadata
+ *
+ * @remarks
+ * Type alias for the `BillingMetadata` OpenAPI schema.
+ * This type represents billingmetadata data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getBillingMetadata();
+ * const item: BillingMetadata = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type BillingMetadata = components['schemas']['BillingMetadata'];
+/**
+ * BillingPlan
+ *
+ * @remarks
+ * Type alias for the `BillingPlan` OpenAPI schema.
+ * This type represents billingplan data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getBillingPlan();
+ * const item: BillingPlan = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type BillingPlan = components['schemas']['BillingPlan'];
 /**
  * BillingTransactionAction
  *
@@ -1819,21 +1851,21 @@ export type OrganizationToken = components['schemas']['OrganizationTokenResponse
  */
 export type OrganizationUpdate = components['schemas']['OrganizationUpdate'];
 /**
- * OrganizationWithPlan
+ * OrganizationWithBillingData
  *
  * @remarks
- * Type alias for the `OrganizationWithPlan` OpenAPI schema.
- * This type represents organizationwithplan data structures used in API requests and responses.
+ * Type alias for the `OrganizationWithBillingData` OpenAPI schema.
+ * This type represents organizationwithbillingdata data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getOrganizationWithPlan();
- * const item: OrganizationWithPlan = response.results;
+ * const response = await api.getOrganizationWithBillingData();
+ * const item: OrganizationWithBillingData = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type OrganizationWithPlan = components['schemas']['OrganizationWithPlan'];
+export type OrganizationWithBillingData = components['schemas']['OrganizationWithBillingData'];
 /**
  * PaginationMetadata
  *

package/src/openapi.yaml

@@ -23,6 +23,54 @@ components:
       - max
       title: AllowedNumberOfNameserverBase
       type: object
+    BillingMetadata:
+      properties:
+        billing_model:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Payment terms for the organization.
+          title: Billing Model
+        customer_number:
+          anyOf:
+          - type: integer
+          - type: 'null'
+          description: Customer account number for the organization.
+          title: Customer Number
+      title: BillingMetadata
+      type: object
+    BillingPlan:
+      properties:
+        amount:
+          default: '0.00'
+          description: Price of the billing plan.
+          title: Amount
+          type: string
+        currency:
+          anyOf:
+          - $ref: '#/components/schemas/Currency'
+          - type: 'null'
+          description: Currency of the billing plan.
+        name:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Name of the billing plan.
+          title: Name
+        plan_id:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Billing plan ID for the organization.
+          title: Plan Id
+        type:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Plan type or billing interval.
+          title: Type
+      title: BillingPlan
+      type: object
     BillingTransactionAction:
       enum:
       - create
@@ -3268,8 +3316,15 @@ components:
           title: Tax Rate
       title: OrganizationUpdate
       type: object
-    OrganizationWithPlan:
+    OrganizationWithBillingData:
       properties:
+        account_balance:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Account Balance
+        active_plan:
+          $ref: '#/components/schemas/BillingPlan'
         address_1:
           anyOf:
           - minLength: 1
@@ -3289,6 +3344,8 @@ components:
             $ref: '#/components/schemas/OrganizationAttribute'
           title: Attributes
           type: array
+        billing_metadata:
+          $ref: '#/components/schemas/BillingMetadata'
         business_number:
           anyOf:
           - maxLength: 100
@@ -3363,9 +3420,6 @@ components:
           - type: 'null'
           description: ID of the parent organization.
           title: Parent Organization Id
-        plan:
-          $ref: '#/components/schemas/PlanRelation'
-          default: basic_plan
         postal_code:
           anyOf:
           - maxLength: 20
@@ -3414,7 +3468,7 @@ components:
           type: array
       required:
       - name
-      title: OrganizationWithPlan
+      title: OrganizationWithBillingData
       type: object
     PaginationMetadata:
       properties:
@@ -5138,7 +5192,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-09-123217
+  version: 2025-09-10-192345
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8821,7 +8875,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OrganizationWithPlan'
+                $ref: '#/components/schemas/OrganizationWithBillingData'
           description: Successful Response
         '422':
           content:
@@ -8898,7 +8952,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OrganizationWithPlan'
+                $ref: '#/components/schemas/OrganizationWithBillingData'
           description: Successful Response
         '422':
           content:
@@ -9108,7 +9162,6 @@ paths:
       summary: Create User Password Reset
       tags:
       - user
-      - user
   /v1/users/email/verify:
     get:
       operationId: redirect_verify_user_v1_users_email_verify_get
@@ -9134,7 +9187,6 @@ paths:
       summary: Redirect Verify User
       tags:
       - user
-      - user
   /v1/users/me:
     get:
       operationId: get_current_user_v1_users_me_get
@@ -9202,7 +9254,6 @@ paths:
       summary: Confirm User Password Reset Me
       tags:
       - user
-      - user
   /v1/users/me/verification:
     delete:
       operationId: cancel_verification_me_v1_users_me_verification_delete
@@ -9226,7 +9277,6 @@ paths:
       summary: Cancel Verification Me
       tags:
       - user
-      - user
     get:
       operationId: get_verification_status_me_v1_users_me_verification_get
       responses:
@@ -9253,7 +9303,6 @@ paths:
       summary: Get Verification Status Me
       tags:
       - user
-      - user
     patch:
       operationId: update_verification_me_v1_users_me_verification_patch
       parameters:
@@ -9316,7 +9365,6 @@ paths:
       summary: Update Verification Me
       tags:
       - user
-      - user
     post:
       operationId: create_verification_me_v1_users_me_verification_post
       parameters:
@@ -9382,7 +9430,6 @@ paths:
       summary: Create Verification Me
       tags:
       - user
-      - user
   /v1/users/{user_id}:
     delete:
       operationId: delete_user_v1_users__user_id__delete
@@ -9649,7 +9696,6 @@ paths:
       summary: Cancel Verification
       tags:
       - user
-      - user
     get:
       operationId: get_verification_status_v1_users__user_id__verification_get
       parameters:
@@ -9694,7 +9740,6 @@ paths:
       summary: Get Verification Status
       tags:
       - user
-      - user
     patch:
       operationId: update_verification_v1_users__user_id__verification_patch
       parameters:
@@ -9768,7 +9813,6 @@ paths:
       summary: Update Verification
       tags:
       - user
-      - user
     post:
       operationId: create_verification_v1_users__user_id__verification_post
       parameters:
@@ -9846,7 +9890,6 @@ paths:
       summary: Create Verification
       tags:
       - user
-      - user
 servers:
 - description: Production environment
   url: https://api.opusdns.com

package/src/schema.d.ts

@@ -1226,6 +1226,45 @@ export interface components {
              */
             min: number;
         };
+        /** BillingMetadata */
+        BillingMetadata: {
+            /**
+             * Billing Model
+             * @description Payment terms for the organization.
+             */
+            billing_model?: string | null;
+            /**
+             * Customer Number
+             * @description Customer account number for the organization.
+             */
+            customer_number?: number | null;
+        };
+        /** BillingPlan */
+        BillingPlan: {
+            /**
+             * Amount
+             * @description Price of the billing plan.
+             * @default 0.00
+             */
+            amount: string;
+            /** @description Currency of the billing plan. */
+            currency?: components["schemas"]["Currency"] | null;
+            /**
+             * Name
+             * @description Name of the billing plan.
+             */
+            name?: string | null;
+            /**
+             * Plan Id
+             * @description Billing plan ID for the organization.
+             */
+            plan_id?: string | null;
+            /**
+             * Type
+             * @description Plan type or billing interval.
+             */
+            type?: string | null;
+        };
         /**
          * BillingTransactionAction
          * @enum {string}
@@ -3417,8 +3456,11 @@ export interface components {
              */
             tax_rate?: number | string | null;
         };
-        /** OrganizationWithPlan */
-        OrganizationWithPlan: {
+        /** OrganizationWithBillingData */
+        OrganizationWithBillingData: {
+            /** Account Balance */
+            account_balance?: string | null;
+            active_plan?: components["schemas"]["BillingPlan"];
             /**
              * Address 1
              * @description First line of the organization's address.
@@ -3431,6 +3473,7 @@ export interface components {
             address_2?: string | null;
             /** Attributes */
             attributes?: components["schemas"]["OrganizationAttribute"][];
+            billing_metadata?: components["schemas"]["BillingMetadata"];
             /**
              * Business Number
              * @description Government issued business identifier for the organization issued.
@@ -3480,8 +3523,6 @@ export interface components {
              * @description ID of the parent organization.
              */
             parent_organization_id?: TypeID<"organization"> | null;
-            /** @default basic_plan */
-            plan: components["schemas"]["PlanRelation"];
             /**
              * Postal Code
              * @description Postal code of the organization's address.
@@ -7929,7 +7970,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["OrganizationWithPlan"];
+                    "application/json": components["schemas"]["OrganizationWithBillingData"];
                 };
             };
             /** @description Validation Error */
@@ -8028,7 +8069,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["OrganizationWithPlan"];
+                    "application/json": components["schemas"]["OrganizationWithBillingData"];
                 };
             };
             /** @description Validation Error */