@opusdns/api 0.33.0 → 0.35.0

package/src/helpers/requests.d.ts

@@ -34,7 +34,7 @@ import { operations } from '../schema';
 
 import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
+import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET AuthClientCredentials endpoint
@@ -3215,58 +3215,6 @@ export type PATCH_OrganizationsOrganizationId_Request_Path = PATCH_Organizations
  */
 export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_OrganizationsOrganizationId_Request['requestBody'];
 
-/**
- * Request type for PATCH OrganizationsOrganizationIdPlan endpoint
- *
- * Change Plan
- *
- * @remarks
- * This type defines the complete request structure for the PATCH OrganizationsOrganizationIdPlan endpoint.
- * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
- * Use this type to ensure type safety when making API requests to this endpoint.
- *
- * @example
- * Use this type to ensure type safety when making API requests to this endpoint.
- *
- * @path /v1/organizations/{organization_id}/plan
- *
- * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Query} - Query parameters type
- * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Path} - Path parameters type
- * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Body} - Request body type
- */
-export type PATCH_OrganizationsOrganizationIdPlan_Request = {
-  parameters: {
-    path: operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
-  };
-  requestBody: PlanUpdate;
-}
-/**
- * Path parameters for PATCH /v1/organizations/{organization_id}/plan
- *
- * @remarks
- * This type defines the path parameters for the PATCH /v1/organizations/{organization_id}/plan endpoint.
- * It provides type safety for all path parameters as defined in the OpenAPI specification.
- *
- * @example
- * Use this type to ensure type safety for path parameters.
- *
- * @path /v1/organizations/{organization_id}/plan
- */
-export type PATCH_OrganizationsOrganizationIdPlan_Request_Path = PATCH_OrganizationsOrganizationIdPlan_Request['parameters']['path'];
-/**
- * Request body for PATCH /v1/organizations/{organization_id}/plan
- *
- * @remarks
- * This type defines the request body structure for the PATCH /v1/organizations/{organization_id}/plan endpoint.
- * It provides type safety for the request body as defined in the OpenAPI specification.
- *
- * @example
- * Use this type to ensure type safety for request body structure.
- *
- * @path /v1/organizations/{organization_id}/plan
- */
-export type PATCH_OrganizationsOrganizationIdPlan_Request_Body = PATCH_OrganizationsOrganizationIdPlan_Request['requestBody'];
-
 /**
  * Request type for GET OrganizationsOrganizationIdPlans endpoint
  *

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
@@ -4515,61 +4515,6 @@ export type PATCH_OrganizationsByOrganizationId_Response_200 = Organization
  */
 export type PATCH_OrganizationsByOrganizationId_Response_422 = HTTPValidationError
 
-/**
- * Response types for PATCH OrganizationsByOrganizationIdPlan endpoint
- *
- * Change Plan
- *
- * @remarks
- * This type defines all possible response structures for the PATCH OrganizationsByOrganizationIdPlan endpoint.
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
- * Use this type to ensure type safety when handling API responses from this endpoint.
- *
-
- *
- * @path /v1/organizations/{organization_id}/plan
- *
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_200} - 200 response type
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_422} - 422 response type
- *
-
- */
-export type PATCH_OrganizationsByOrganizationIdPlan_Response = PATCH_OrganizationsByOrganizationIdPlan_Response_200 | PATCH_OrganizationsByOrganizationIdPlan_Response_422;
-
-/**
- * 200 response for PATCH OrganizationsByOrganizationIdPlan endpoint
- *
- * @remarks
- * This type defines the response structure for the 200 status code
- * of the PATCH OrganizationsByOrganizationIdPlan endpoint.
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
- *
-
- *
- * @path /v1/organizations/{organization_id}/plan
- *
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
- * @see {@link OrganizationWithPlan} - The actual schema type definition
- */
-export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationWithPlan
-
-/**
- * 422 response for PATCH OrganizationsByOrganizationIdPlan endpoint
- *
- * @remarks
- * This type defines the response structure for the 422 status code
- * of the PATCH OrganizationsByOrganizationIdPlan endpoint.
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
- *
-
- *
- * @path /v1/organizations/{organization_id}/plan
- *
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
- * @see {@link HTTPValidationError} - The actual schema type definition
- */
-export type PATCH_OrganizationsByOrganizationIdPlan_Response_422 = HTTPValidationError
-
 /**
  * Response types for GET OrganizationsByOrganizationIdPlans 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
  *
@@ -2122,38 +2154,6 @@ export type PermissionSet = components['schemas']['PermissionSet'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type PlanInfo = components['schemas']['PlanInfo'];
-/**
- * PlanRelation
- *
- * @remarks
- * Type alias for the `PlanRelation` OpenAPI schema.
- * This type represents planrelation data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getPlanRelation();
- * const item: PlanRelation = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type PlanRelation = components['schemas']['PlanRelation'];
-/**
- * PlanUpdate
- *
- * @remarks
- * Type alias for the `PlanUpdate` OpenAPI schema.
- * This type represents planupdate data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getPlanUpdate();
- * const item: PlanUpdate = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type PlanUpdate = components['schemas']['PlanUpdate'];
 /**
  * PostTransferRequirements
  *

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:
@@ -3624,9 +3678,10 @@ components:
       - bulk_renew_expire
       - bulk_transfer_trade
       - bulk_update
+      - corporate_plan
       - create
       - delete
-      - enterprise
+      - enterprise_plan
       - has_accepted_tos
       - manage_api_keys
       - manage_billing
@@ -3641,10 +3696,9 @@ components:
       - manage_user_relations
       - manage_users
       - plan_manager
-      - premium
-      - premium_reseller
+      - premium_plan
       - renew_expire
-      - starter
+      - starter_plan
       - transfer_trade
       - update
       - verify
@@ -3699,21 +3753,6 @@ components:
       - amount
       title: PlanInfo
       type: object
-    PlanRelation:
-      enum:
-      - basic_plan
-      - enterprise_plan
-      - premium_plan
-      - starter_plan
-      title: PlanRelation
-      type: string
-    PlanUpdate:
-      properties:
-        plan:
-          $ref: '#/components/schemas/PlanRelation'
-          default: basic_plan
-      title: PlanUpdate
-      type: object
     PostTransferRequirements:
       enum:
       - update_contacts
@@ -5138,7 +5177,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-09-123217
+  version: 2025-09-10-232127
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8821,7 +8860,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OrganizationWithPlan'
+                $ref: '#/components/schemas/OrganizationWithBillingData'
           description: Successful Response
         '422':
           content:
@@ -8872,45 +8911,6 @@ paths:
       summary: Update Organization
       tags:
       - organization
-  /v1/organizations/{organization_id}/plan:
-    patch:
-      operationId: change_plan_v1_organizations__organization_id__plan_patch
-      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
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/PlanUpdate'
-        required: true
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/OrganizationWithPlan'
-          description: Successful Response
-        '422':
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
-      security:
-      - OAuth2PasswordBearer: []
-      summary: Change Plan
-      tags:
-      - organization
   /v1/organizations/{organization_id}/plans:
     get:
       operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
@@ -9108,7 +9108,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 +9133,6 @@ paths:
       summary: Redirect Verify User
       tags:
       - user
-      - user
   /v1/users/me:
     get:
       operationId: get_current_user_v1_users_me_get
@@ -9202,7 +9200,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 +9223,6 @@ paths:
       summary: Cancel Verification Me
       tags:
       - user
-      - user
     get:
       operationId: get_verification_status_me_v1_users_me_verification_get
       responses:
@@ -9253,7 +9249,6 @@ paths:
       summary: Get Verification Status Me
       tags:
       - user
-      - user
     patch:
       operationId: update_verification_me_v1_users_me_verification_patch
       parameters:
@@ -9316,7 +9311,6 @@ paths:
       summary: Update Verification Me
       tags:
       - user
-      - user
     post:
       operationId: create_verification_me_v1_users_me_verification_post
       parameters:
@@ -9382,7 +9376,6 @@ paths:
       summary: Create Verification Me
       tags:
       - user
-      - user
   /v1/users/{user_id}:
     delete:
       operationId: delete_user_v1_users__user_id__delete
@@ -9649,7 +9642,6 @@ paths:
       summary: Cancel Verification
       tags:
       - user
-      - user
     get:
       operationId: get_verification_status_v1_users__user_id__verification_get
       parameters:
@@ -9694,7 +9686,6 @@ paths:
       summary: Get Verification Status
       tags:
       - user
-      - user
     patch:
       operationId: update_verification_v1_users__user_id__verification_patch
       parameters:
@@ -9768,7 +9759,6 @@ paths:
       summary: Update Verification
       tags:
       - user
-      - user
     post:
       operationId: create_verification_v1_users__user_id__verification_post
       parameters:
@@ -9846,7 +9836,6 @@ paths:
       summary: Create Verification
       tags:
       - user
-      - user
 servers:
 - description: Production environment
   url: https://api.opusdns.com