@opusdns/api 0.53.0 → 0.54.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PlanRelation, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AgreementType. Auto-generated enum for AgreementType
@@ -1809,6 +1809,62 @@ export const PERMISSION_VALUES = [
   'view_events'
 ] as const satisfies [string, ...string[]] | Permission[];
 
+/**
+ * PlanRelation. Auto-generated enum for PlanRelation
+ *
+ * @remarks
+ * This constant provides both object and array forms for the PlanRelation enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = PLAN_RELATION.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = PLAN_RELATION_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link PlanRelation} - The TypeScript type definition
+ */
+export const PLAN_RELATION = {
+  BASIC: "basic",
+  ENTERPRISE: "enterprise",
+  CORPORATE: "corporate",
+  PREMIUM: "premium",
+  STARTER: "starter",
+} as const satisfies Record<string, PlanRelation>;
+
+/**
+ * Array of all PlanRelation enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid PlanRelation enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of PLAN_RELATION_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = PLAN_RELATION_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link PlanRelation} - The TypeScript type definition
+ * @see {@link PLAN_RELATION} - The object form of this enum
+ */
+export const PLAN_RELATION_VALUES = [
+  'basic',
+  'enterprise',
+  'corporate',
+  'premium',
+  'starter'
+] as const satisfies [string, ...string[]] | PlanRelation[];
+
 /**
  * PostTransferRequirements. Auto-generated enum for PostTransferRequirements
  *

package/src/helpers/keys.ts

@@ -121,6 +121,7 @@ import { PasswordUpdate } from './schemas';
 import { Period } from './schemas';
 import { PermissionSet } from './schemas';
 import { PlanInfo } from './schemas';
+import { PlanUpdate } from './schemas';
 import { PremiumDomainsBase } from './schemas';
 import { PriceInfo } from './schemas';
 import { Problem } from './schemas';
@@ -15081,6 +15082,55 @@ export const KEYS_PLAN_INFO = [
   KEY_PLAN_INFO_PLAN_TYPE,
 ] as const satisfies (keyof PlanInfo)[];
 
+/**
+ * plan property
+ *
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `plan` property of PlanUpdate objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = planupdate[KEY_PLAN_UPDATE_PLAN];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PLAN_UPDATE_PLAN;
+ * const value = planupdate[propertyName];
+ * ```
+ *
+ * @see {@link PlanUpdate} - The TypeScript type definition
+ * @see {@link KEYS_PLAN_UPDATE} - Array of all keys for this type
+ */
+export const KEY_PLAN_UPDATE_PLAN = 'plan' as keyof PlanUpdate;
+
+/**
+ * Array of all PlanUpdate property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for PlanUpdate objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_PLAN_UPDATE) {
+ *   console.log(`Property: ${key}, Value: ${planupdate[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_PLAN_UPDATE.includes(someKey);
+ * ```
+ *
+ * @see {@link PlanUpdate} - The TypeScript type definition
+ */
+export const KEYS_PLAN_UPDATE = [
+  KEY_PLAN_UPDATE_PLAN,
+] as const satisfies (keyof PlanUpdate)[];
+
 /**
  * Affects
  *

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, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
+import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET AuthClientCredentials endpoint
@@ -3281,6 +3281,58 @@ 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

@@ -4645,6 +4645,61 @@ 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 OrganizationWithBillingData} - The actual schema type definition
+ */
+export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationWithBillingData
+
+/**
+ * 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

@@ -2239,6 +2239,38 @@ 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

@@ -3880,6 +3880,22 @@ components:
       - amount
       title: PlanInfo
       type: object
+    PlanRelation:
+      enum:
+      - basic
+      - enterprise
+      - corporate
+      - premium
+      - starter
+      title: PlanRelation
+      type: string
+    PlanUpdate:
+      properties:
+        plan:
+          $ref: '#/components/schemas/PlanRelation'
+          default: basic
+      title: PlanUpdate
+      type: object
     PostTransferRequirements:
       enum:
       - update_contacts
@@ -5357,7 +5373,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-18-175058
+  version: 2025-09-18-175712
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -9213,6 +9229,45 @@ 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/OrganizationWithBillingData'
+          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

package/src/schema.d.ts

@@ -971,6 +971,23 @@ export interface paths {
         patch: operations["update_organization_v1_organizations__organization_id__patch"];
         trace?: never;
     };
+    "/v1/organizations/{organization_id}/plan": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /** Change Plan */
+        patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
+        trace?: never;
+    };
     "/v1/organizations/{organization_id}/plans": {
         parameters: {
             query?: never;
@@ -3801,6 +3818,16 @@ export interface components {
              */
             plan_type?: string | null;
         };
+        /**
+         * PlanRelation
+         * @enum {string}
+         */
+        PlanRelation: "basic" | "enterprise" | "corporate" | "premium" | "starter";
+        /** PlanUpdate */
+        PlanUpdate: {
+            /** @default basic */
+            plan: components["schemas"]["PlanRelation"];
+        };
         /**
          * PostTransferRequirements
          * @enum {string}
@@ -8287,6 +8314,41 @@ export interface operations {
             };
         };
     };
+    change_plan_v1_organizations__organization_id__plan_patch: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                organization_id: TypeId<"organization">;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PlanUpdate"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrganizationWithBillingData"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_current_available_plans_v1_organizations__organization_id__plans_get: {
         parameters: {
             query?: never;