@opusdns/api 0.61.0 → 0.63.0

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:
@@ -137,6 +204,27 @@ components:
           title: Username
       title: Body_issue_organization_token_v1_auth_token_post
       type: object
+    CheckoutSessionRequest:
+      properties:
+        return_url:
+          description: Return URL that will be used
+          title: Return Url
+          type: string
+      required:
+      - return_url
+      title: CheckoutSessionRequest
+      type: object
+    CheckoutSessionResponse:
+      properties:
+        session_client_secret:
+          description: Checkout session client secret - meant to be used in the embedded
+            checkout
+          title: Session Client Secret
+          type: string
+      required:
+      - session_client_secret
+      title: CheckoutSessionResponse
+      type: object
     ContactConfigBase:
       properties:
         max:
@@ -746,6 +834,47 @@ components:
       - EUR
       title: Currency
       type: string
+    CustomerCreditCardPaymentMethod:
+      properties:
+        brand:
+          description: Card brand
+          title: Brand
+          type: string
+        country:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Country code
+          title: Country
+        exp_month:
+          description: Expiration month
+          title: Exp Month
+          type: integer
+        exp_year:
+          description: Expiration year
+          title: Exp Year
+          type: integer
+        id:
+          description: Payment method ID
+          title: Id
+          type: string
+        is_default:
+          description: Whether this is the default payment method
+          title: Is Default
+          type: boolean
+        last4:
+          description: Last four digits of the card
+          title: Last4
+          type: string
+      required:
+      - id
+      - brand
+      - last4
+      - exp_month
+      - exp_year
+      - is_default
+      title: CustomerCreditCardPaymentMethod
+      type: object
     DeletePolicyType:
       enum:
       - immediate
@@ -3444,6 +3573,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:
@@ -4824,6 +4967,59 @@ components:
       - email
       title: VerificationType
       type: string
+    WalletCreditRequest:
+      properties:
+        amount:
+          anyOf:
+          - type: number
+          - type: string
+          description: Amount to credit the customer wallet
+          title: Amount
+        payment_method_id:
+          description: Payment method ID that should be used
+          title: Payment Method Id
+          type: string
+      required:
+      - amount
+      - payment_method_id
+      title: WalletCreditRequest
+      type: object
+    WalletCreditResponseStatus:
+      enum:
+      - success
+      - failed
+      title: WalletCreditResponseStatus
+      type: string
+    WalletCreditResponseWithBalance:
+      properties:
+        amount:
+          description: Amount credited to the customer wallet
+          title: Amount
+          type: string
+        balance:
+          description: Updated wallet balance after the credit
+          title: Balance
+          type: string
+        credit_id:
+          description: Unique identifier of the wallet credit transaction
+          title: Credit Id
+          type: string
+        message:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Optional human-readable message describing the result
+          title: Message
+        status:
+          $ref: '#/components/schemas/WalletCreditResponseStatus'
+          description: Status of the credit operation
+      required:
+      - credit_id
+      - amount
+      - status
+      - balance
+      title: WalletCreditResponseWithBalance
+      type: object
     WhoisBase:
       properties:
         whois_server:
@@ -4928,7 +5124,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-22-215413
+  version: 2025-09-24-162647
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8536,6 +8732,204 @@ paths:
       summary: Update Organization
       tags:
       - organization
+  /v1/organizations/{organization_id}/billing/checkout-sessions:
+    post:
+      operationId: get_checkout_session_v1_organizations__organization_id__billing_checkout_sessions_post
+      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/CheckoutSessionRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CheckoutSessionResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get Checkout Session
+      tags:
+      - organization
+      - organization
+  /v1/organizations/{organization_id}/billing/payment-methods:
+    get:
+      operationId: list_payment_methods_v1_organizations__organization_id__billing_payment_methods_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:
+                items:
+                  $ref: '#/components/schemas/CustomerCreditCardPaymentMethod'
+                title: Response List Payment Methods V1 Organizations  Organization
+                  Id  Billing Payment Methods Get
+                type: array
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: List Payment Methods
+      tags:
+      - organization
+      - organization
+  /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}:
+    delete:
+      operationId: delete_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__delete
+      parameters:
+      - in: path
+        name: payment_method_id
+        required: true
+        schema:
+          title: Payment Method Id
+          type: string
+      - 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:
+        '204':
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Delete Payment Method
+      tags:
+      - organization
+      - organization
+  /v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default:
+    patch:
+      operationId: update_default_payment_method_v1_organizations__organization_id__billing_payment_methods__payment_method_id__default_patch
+      parameters:
+      - in: path
+        name: payment_method_id
+        required: true
+        schema:
+          title: Payment Method Id
+          type: string
+      - 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:
+                items:
+                  $ref: '#/components/schemas/CustomerCreditCardPaymentMethod'
+                title: Response Update Default Payment Method V1 Organizations  Organization
+                  Id  Billing Payment Methods  Payment Method Id  Default Patch
+                type: array
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Update Default Payment Method
+      tags:
+      - organization
+      - organization
+  /v1/organizations/{organization_id}/billing/wallet/credits:
+    post:
+      operationId: credit_wallet_v1_organizations__organization_id__billing_wallet_credits_post
+      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/WalletCreditRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WalletCreditResponseWithBalance'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Credit Wallet
+      tags:
+      - organization
+      - organization
   /v1/organizations/{organization_id}/plan:
     patch:
       operationId: change_plan_v1_organizations__organization_id__plan_patch
@@ -8662,6 +9056,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