@opusdns/api 0.60.0 → 0.62.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, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, 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, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET AuthClientCredentials endpoint
@@ -4461,6 +4461,116 @@ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Res
  */
 export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET OrganizationsByOrganizationIdTransactions endpoint
+ *
+ * Get transactions for an organization
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET OrganizationsByOrganizationIdTransactions 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}/transactions
+ *
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response_200} - 200 response type
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response_422} - 422 response type
+ *
+
+ */
+export type GET_OrganizationsByOrganizationIdTransactions_Response = GET_OrganizationsByOrganizationIdTransactions_Response_200 | GET_OrganizationsByOrganizationIdTransactions_Response_422;
+
+/**
+ * 200 response for GET OrganizationsByOrganizationIdTransactions endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET OrganizationsByOrganizationIdTransactions endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/organizations/{organization_id}/transactions
+ *
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response} - The main response type definition
+ * @see {@link Pagination_BillingTransaction} - The actual schema type definition
+ */
+export type GET_OrganizationsByOrganizationIdTransactions_Response_200 = Pagination_BillingTransaction
+
+/**
+ * 422 response for GET OrganizationsByOrganizationIdTransactions endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET OrganizationsByOrganizationIdTransactions endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/organizations/{organization_id}/transactions
+ *
+ * @see {@link GET_OrganizationsByOrganizationIdTransactions_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_OrganizationsByOrganizationIdTransactions_Response_422 = HTTPValidationError
+
+/**
+ * Response types for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
+ *
+ * Get a specific transaction for an organization
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET OrganizationsByOrganizationIdTransactionsByTransactionId 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}/transactions/{transaction_id}
+ *
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200} - 200 response type
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422} - 422 response type
+ *
+
+ */
+export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response = GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200 | GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422;
+
+/**
+ * 200 response for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/organizations/{organization_id}/transactions/{transaction_id}
+ *
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response} - The main response type definition
+ * @see {@link BillingTransaction} - The actual schema type definition
+ */
+export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_200 = BillingTransaction
+
+/**
+ * 422 response for GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET OrganizationsByOrganizationIdTransactionsByTransactionId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/organizations/{organization_id}/transactions/{transaction_id}
+ *
+ * @see {@link GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_OrganizationsByOrganizationIdTransactionsByTransactionId_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET OrganizationsIpRestrictions endpoint
  *

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -499,6 +499,20 @@ export type OrganizationAttributeCreateArray = OrganizationAttributeCreate[];
  * @see {@link UserCreate} - The individual UserCreate type definition
  */
 export type UserCreateArray = UserCreate[];
+/**
+ * BillingTransactionResponse
+ *
+ * @remarks
+ * Array type for BillingTransactionResponse objects. Used when the API returns a collection of BillingTransactionResponse instances.
+ *
+ * @example
+ * ```typescript
+ * const items: BillingTransactionArray = await api.getBillingTransactions();
+ * ```
+ *
+ * @see {@link BillingTransaction} - The individual BillingTransactionResponse type definition
+ */
+export type BillingTransactionArray = BillingTransaction[];
 /**
  * ContactSchema
  *

package/src/helpers/schemas.d.ts

@@ -138,6 +138,54 @@ export type BillingTransactionAction = components['schemas']['BillingTransaction
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type BillingTransactionProductType = components['schemas']['BillingTransactionProductType'];
+/**
+ * BillingTransactionResponse
+ *
+ * @remarks
+ * Type alias for the `BillingTransactionResponse` OpenAPI schema.
+ * This type represents billingtransactionresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getBillingTransaction();
+ * const item: BillingTransaction = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type BillingTransaction = components['schemas']['BillingTransactionResponse'];
+/**
+ * BillingTransactionSortField
+ *
+ * @remarks
+ * Type alias for the `BillingTransactionSortField` OpenAPI schema.
+ * This type represents billingtransactionsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getBillingTransactionSortField();
+ * const item: BillingTransactionSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type BillingTransactionSortField = components['schemas']['BillingTransactionSortField'];
+/**
+ * BillingTransactionStatus
+ *
+ * @remarks
+ * Type alias for the `BillingTransactionStatus` OpenAPI schema.
+ * This type represents billingtransactionstatus data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getBillingTransactionStatus();
+ * const item: BillingTransactionStatus = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type BillingTransactionStatus = components['schemas']['BillingTransactionStatus'];
 /**
  * Body_issue_organization_token_v1_auth_token_post
  *
@@ -1903,6 +1951,22 @@ export type OrganizationWithBillingData = components['schemas']['OrganizationWit
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type PaginationMetadata = components['schemas']['PaginationMetadata'];
+/**
+ * Pagination[BillingTransactionResponse]
+ *
+ * @remarks
+ * Type alias for the `Pagination_BillingTransactionResponse_` OpenAPI schema.
+ * This type represents pagination[billingtransactionresponse] data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPagination_BillingTransaction();
+ * const item: Pagination_BillingTransaction = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Pagination_BillingTransaction = components['schemas']['Pagination_BillingTransactionResponse_'];
 /**
  * Pagination[ContactSchema]
  *
@@ -2287,6 +2351,22 @@ export type PremiumSourceType = components['schemas']['PremiumSourceType'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type PriceInfo = components['schemas']['PriceInfo'];
+/**
+ * PricingPeriod
+ *
+ * @remarks
+ * Type alias for the `PricingPeriod` OpenAPI schema.
+ * This type represents pricingperiod data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPricingPeriod();
+ * const item: PricingPeriod = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type PricingPeriod = components['schemas']['PricingPeriod'];
 /**
  * Problem
  *

package/src/openapi.yaml

@@ -101,6 +101,73 @@ components:
       - domain_forward
       title: BillingTransactionProductType
       type: string
+    BillingTransactionResponse:
+      properties:
+        action:
+          $ref: '#/components/schemas/BillingTransactionAction'
+          description: The action performed in the transaction
+        billing_transaction_id:
+          examples:
+          - billing_transaction_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^billing_transaction_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Billing Transaction Id
+          type: string
+          x-typeid-prefix: billing_transaction
+        completed_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date/time the transaction completed
+          title: Completed On
+        created_on:
+          description: The date/time the transaction was created
+          format: date-time
+          title: Created On
+          type: string
+        product_reference:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          description: The reference of the product
+          title: Product Reference
+        product_type:
+          $ref: '#/components/schemas/BillingTransactionProductType'
+          description: The type of product
+        status:
+          $ref: '#/components/schemas/BillingTransactionStatus'
+          default: pending
+          description: The status of the transaction
+        updated_on:
+          description: The date/time the transaction was updated
+          format: date-time
+          title: Updated On
+          type: string
+      required:
+      - product_type
+      - product_reference
+      - action
+      title: BillingTransactionResponse
+      type: object
+    BillingTransactionSortField:
+      enum:
+      - product_type
+      - action
+      - status
+      - created_on
+      - completed_on
+      title: BillingTransactionSortField
+      type: string
+    BillingTransactionStatus:
+      enum:
+      - pending
+      - succeeded
+      - failed
+      - canceled
+      title: BillingTransactionStatus
+      type: string
     Body_issue_organization_token_v1_auth_token_post:
       properties:
         client_id:
@@ -3444,6 +3511,20 @@ components:
       - has_previous_page
       title: PaginationMetadata
       type: object
+    Pagination_BillingTransactionResponse_:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadata'
+        results:
+          items:
+            $ref: '#/components/schemas/BillingTransactionResponse'
+          title: Results
+          type: array
+      required:
+      - results
+      - pagination
+      title: Pagination[BillingTransactionResponse]
+      type: object
     Pagination_ContactSchema_:
       properties:
         pagination:
@@ -3756,18 +3837,11 @@ components:
         currency:
           title: Currency
           type: string
-        period_unit:
-          anyOf:
-          - type: string
-          - type: 'null'
-          description: 'Period unit: ''y'' (year), ''m'' (month), ''d'' (day)'
-          title: Period Unit
-        period_value:
+        period:
           anyOf:
-          - type: integer
+          - $ref: '#/components/schemas/PricingPeriod'
           - type: 'null'
-          description: Period value (e.g., 1 for 1 year)
-          title: Period Value
+          description: Pricing period (e.g., 1 year, 2 months)
         price:
           title: Price
           type: string
@@ -3790,6 +3864,21 @@ components:
       - currency
       title: PriceInfo
       type: object
+    PricingPeriod:
+      properties:
+        unit:
+          $ref: '#/components/schemas/PeriodUnit'
+          description: The unit of the period
+        value:
+          description: Amount of time in the unit
+          exclusiveMinimum: 0.0
+          title: Value
+          type: integer
+      required:
+      - value
+      - unit
+      title: PricingPeriod
+      type: object
     Problem:
       properties:
         detail:
@@ -4920,7 +5009,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-22-190002
+  version: 2025-09-24-153436
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8654,6 +8743,181 @@ paths:
       summary: Get Pricing Plans
       tags:
       - organization
+  /v1/organizations/{organization_id}/transactions:
+    get:
+      operationId: get_transactions_v1_organizations__organization_id__transactions_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: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/BillingTransactionSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: product_reference
+        required: false
+        schema:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          title: Product Reference
+      - in: query
+        name: product_type
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/BillingTransactionProductType'
+          - type: 'null'
+          title: Product Type
+      - in: query
+        name: action
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/BillingTransactionAction'
+          - type: 'null'
+          title: Action
+      - in: query
+        name: status
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/BillingTransactionStatus'
+          - type: 'null'
+          title: Status
+      - in: query
+        name: created_after
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Created After
+      - in: query
+        name: created_before
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Created Before
+      - in: query
+        name: completed_after
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Completed After
+      - in: query
+        name: completed_before
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Completed Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_BillingTransactionResponse_'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get transactions for an organization
+      tags:
+      - organization
+  /v1/organizations/{organization_id}/transactions/{transaction_id}:
+    get:
+      operationId: get_transaction_v1_organizations__organization_id__transactions__transaction_id__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: transaction_id
+        required: true
+        schema:
+          examples:
+          - billing_transaction_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^billing_transaction_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Transaction Id
+          type: string
+          x-typeid-prefix: billing_transaction
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BillingTransactionResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get a specific transaction for an organization
+      tags:
+      - organization
   /v1/tlds/portfolio:
     get:
       operationId: get_tld_portfolio_v1_tlds_portfolio_get