@opusdns/api 0.32.0 → 0.34.0

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:
@@ -3571,6 +3625,17 @@ components:
       - pagination
       title: Pagination[User]
       type: object
+    PasswordUpdate:
+      properties:
+        new_password:
+          examples:
+          - correcthorsebatterystaple
+          title: New Password
+          type: string
+      required:
+      - new_password
+      title: PasswordUpdate
+      type: object
     PatchOp:
       enum:
       - upsert
@@ -3993,6 +4058,16 @@ components:
           title: Remove
       title: SpiceDbRelationshipUpdate
       type: object
+    StartPasswordReset:
+      properties:
+        email:
+          format: email
+          title: Email
+          type: string
+      required:
+      - email
+      title: StartPasswordReset
+      type: object
     SyncOperationType:
       enum:
       - registration
@@ -4506,6 +4581,17 @@ components:
       - notification
       title: UserNotificationSummary
       type: object
+    UserPasswordResetEmailResponse:
+      properties:
+        message:
+          default: A password reset link will be sent to this email if an account
+            is registered under it.
+          description: Message to the user. This message is always displayed regarding
+            the password reset process to prevent leaking information.
+          title: Message
+          type: string
+      title: UserPasswordResetEmailResponse
+      type: object
     UserStatus:
       enum:
       - active
@@ -4592,6 +4678,181 @@ components:
           title: Username
       title: UserUpdate
       type: object
+    UserVerificationApiResponse:
+      properties:
+        canceled_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date the verification was cancelled
+          title: Canceled On
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        status:
+          $ref: '#/components/schemas/EmailVerificationStatus'
+          default: pending
+          description: Current status of the email verification
+        token:
+          description: The token to verify the email address
+          maxLength: 256
+          minLength: 35
+          title: Token
+          type: string
+        type:
+          $ref: '#/components/schemas/VerificationType'
+          description: 'The type of verification: ''api'' for retrieving token via
+            API, ''email'' for retrieving via email'
+        updated_on:
+          description: The date/time the entry was last updated on
+          format: date-time
+          title: Updated On
+          type: string
+        user_id:
+          default: None
+          description: The user's id
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
+        user_verification_id:
+          examples:
+          - user_verification_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Verification Id
+          type: string
+          x-typeid-prefix: user_verification
+        verified_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date the verification was verified
+          title: Verified On
+      required:
+      - token
+      - type
+      title: UserVerificationApiResponse
+      type: object
+    UserVerificationEmailResponse:
+      properties:
+        canceled_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date the verification was cancelled
+          title: Canceled On
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        status:
+          $ref: '#/components/schemas/EmailVerificationStatus'
+          default: pending
+          description: Current status of the email verification
+        type:
+          $ref: '#/components/schemas/VerificationType'
+          description: 'The type of verification: ''api'' for retrieving token via
+            API, ''email'' for retrieving via email'
+        updated_on:
+          description: The date/time the entry was last updated on
+          format: date-time
+          title: Updated On
+          type: string
+        user_id:
+          default: None
+          description: The user's id
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
+        user_verification_id:
+          examples:
+          - user_verification_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Verification Id
+          type: string
+          x-typeid-prefix: user_verification
+        verified_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date the verification was verified
+          title: Verified On
+      required:
+      - type
+      title: UserVerificationEmailResponse
+      type: object
+    UserVerificationResponse:
+      properties:
+        canceled_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date the verification was cancelled
+          title: Canceled On
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        status:
+          $ref: '#/components/schemas/EmailVerificationStatus'
+          default: pending
+          description: Current status of the email verification
+        type:
+          $ref: '#/components/schemas/VerificationType'
+          description: 'The type of verification: ''api'' for retrieving token via
+            API, ''email'' for retrieving via email'
+        updated_on:
+          description: The date/time the entry was last updated on
+          format: date-time
+          title: Updated On
+          type: string
+        user_id:
+          default: None
+          description: The user's id
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
+        user_verification_id:
+          examples:
+          - user_verification_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Verification Id
+          type: string
+          x-typeid-prefix: user_verification
+        verified_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date the verification was verified
+          title: Verified On
+      required:
+      - type
+      title: UserVerificationResponse
+      type: object
     UserWithAttributes:
       properties:
         created_on:
@@ -4931,7 +5192,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-05-210401
+  version: 2025-09-10-192345
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8614,7 +8875,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OrganizationWithPlan'
+                $ref: '#/components/schemas/OrganizationWithBillingData'
           description: Successful Response
         '422':
           content:
@@ -8691,7 +8952,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OrganizationWithPlan'
+                $ref: '#/components/schemas/OrganizationWithBillingData'
           description: Successful Response
         '422':
           content:
@@ -8876,6 +9137,56 @@ paths:
       summary: Create User
       tags:
       - user
+  /v1/users/email/password-reset:
+    post:
+      operationId: create_user_password_reset_v1_users_email_password_reset_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/StartPasswordReset'
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserPasswordResetEmailResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      summary: Create User Password Reset
+      tags:
+      - user
+  /v1/users/email/verify:
+    get:
+      operationId: redirect_verify_user_v1_users_email_verify_get
+      parameters:
+      - in: query
+        name: token
+        required: true
+        schema:
+          title: Token
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema: {}
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      summary: Redirect Verify User
+      tags:
+      - user
   /v1/users/me:
     get:
       operationId: get_current_user_v1_users_me_get
@@ -8908,12 +9219,223 @@ paths:
       summary: Get Current User
       tags:
       - user
-  /v1/users/{user_id}:
-    delete:
-      operationId: delete_user_v1_users__user_id__delete
-      parameters:
-      - in: path
-        name: user_id
+  /v1/users/me/password-reset:
+    patch:
+      operationId: confirm_user_password_reset_me_v1_users_me_password_reset_patch
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PasswordUpdate'
+        required: true
+      responses:
+        '204':
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Confirm User Password Reset Me
+      tags:
+      - user
+  /v1/users/me/verification:
+    delete:
+      operationId: cancel_verification_me_v1_users_me_verification_delete
+      responses:
+        '204':
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Cancel Verification Me
+      tags:
+      - user
+    get:
+      operationId: get_verification_status_me_v1_users_me_verification_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserVerificationResponse'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get Verification Status Me
+      tags:
+      - user
+    patch:
+      operationId: update_verification_me_v1_users_me_verification_patch
+      parameters:
+      - in: query
+        name: token
+        required: true
+        schema:
+          title: Token
+          type: string
+      responses:
+        '204':
+          description: Successful Response
+        '400':
+          content:
+            application/problem+json:
+              examples:
+                User Management Error:
+                  value:
+                    code: ERROR_USER_VERIFICATION_TOKEN_INVALID
+                    detail: Invalid verification token
+                    status: 400
+                    title: User Management Error
+                    type: user-verification-token-invalid
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Bad Request
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_USER_VERIFICATION_NOT_FOUND
+                detail: 'No user verification found for user: user_id=Additional error
+                  context.'
+                status: 404
+                title: User Management Error
+                type: user-verification-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Update Verification Me
+      tags:
+      - user
+    post:
+      operationId: create_verification_me_v1_users_me_verification_post
+      parameters:
+      - in: query
+        name: type
+        required: true
+        schema:
+          $ref: '#/components/schemas/VerificationType'
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                anyOf:
+                - $ref: '#/components/schemas/UserVerificationEmailResponse'
+                - $ref: '#/components/schemas/UserVerificationApiResponse'
+                title: Response Create Verification Me V1 Users Me Verification Post
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_USER_NOT_FOUND
+                detail: Additional error context.
+                status: 404
+                title: User Management Error
+                type: user-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '405':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_USER_VERIFICATION_INVALID_TYPE
+                detail: 'Invalid verification type: Additional error context.'
+                status: 405
+                title: User Management Error
+                type: user-verification-type-invalid
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Method Not Allowed
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Create Verification Me
+      tags:
+      - user
+  /v1/users/{user_id}:
+    delete:
+      operationId: delete_user_v1_users__user_id__delete
+      parameters:
+      - in: path
+        name: user_id
         required: true
         schema:
           examples:
@@ -9133,6 +9655,241 @@ paths:
       summary: Update User Relations
       tags:
       - user
+  /v1/users/{user_id}/verification:
+    delete:
+      operationId: cancel_verification_v1_users__user_id__verification_delete
+      parameters:
+      - in: path
+        name: user_id
+        required: true
+        schema:
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
+      responses:
+        '204':
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Cancel Verification
+      tags:
+      - user
+    get:
+      operationId: get_verification_status_v1_users__user_id__verification_get
+      parameters:
+      - in: path
+        name: user_id
+        required: true
+        schema:
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserVerificationResponse'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get Verification Status
+      tags:
+      - user
+    patch:
+      operationId: update_verification_v1_users__user_id__verification_patch
+      parameters:
+      - in: path
+        name: user_id
+        required: true
+        schema:
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
+      - in: query
+        name: token
+        required: true
+        schema:
+          title: Token
+          type: string
+      responses:
+        '204':
+          description: Successful Response
+        '400':
+          content:
+            application/problem+json:
+              examples:
+                User Management Error:
+                  value:
+                    code: ERROR_USER_VERIFICATION_TOKEN_INVALID
+                    detail: Invalid verification token
+                    status: 400
+                    title: User Management Error
+                    type: user-verification-token-invalid
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Bad Request
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_USER_VERIFICATION_NOT_FOUND
+                detail: 'No user verification found for user: user_id=Additional error
+                  context.'
+                status: 404
+                title: User Management Error
+                type: user-verification-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Update Verification
+      tags:
+      - user
+    post:
+      operationId: create_verification_v1_users__user_id__verification_post
+      parameters:
+      - in: path
+        name: user_id
+        required: true
+        schema:
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
+      - in: query
+        name: type
+        required: true
+        schema:
+          $ref: '#/components/schemas/VerificationType'
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                anyOf:
+                - $ref: '#/components/schemas/UserVerificationEmailResponse'
+                - $ref: '#/components/schemas/UserVerificationApiResponse'
+                title: Response Create Verification V1 Users  User Id  Verification
+                  Post
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_USER_NOT_FOUND
+                detail: Additional error context.
+                status: 404
+                title: User Management Error
+                type: user-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '405':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_USER_VERIFICATION_INVALID_TYPE
+                detail: 'Invalid verification type: Additional error context.'
+                status: 405
+                title: User Management Error
+                type: user-verification-type-invalid
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Method Not Allowed
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Create Verification
+      tags:
+      - user
 servers:
 - description: Production environment
   url: https://api.opusdns.com