@opusdns/api 0.257.0 → 0.259.0

package/src/openapi.yaml

@@ -259,6 +259,70 @@ components:
       - unique
       title: BrowserStatsBucket
       type: object
+    BulkObjectTagChanges:
+      properties:
+        add:
+          description: Tag IDs to add to the objects.
+          items:
+            examples:
+            - tag_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: tag
+          maxItems: 1000
+          title: Add
+          type: array
+        objects:
+          description: Object references to operate on. TypeIDs and resource names
+            may be mixed.
+          items:
+            description: A TypeID (e.g. domain_01h45ytscbebyvny4gc8cr8ma2) or a resource
+              name (e.g. example.com)
+            examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            - example.com
+            type: string
+          maxItems: 1000
+          minItems: 1
+          title: Objects
+          type: array
+        remove:
+          description: Tag IDs to remove from the objects.
+          items:
+            examples:
+            - tag_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: tag
+          maxItems: 1000
+          title: Remove
+          type: array
+        replace:
+          anyOf:
+          - items:
+              examples:
+              - tag_01h45ytscbebyvny4gc8cr8ma2
+              format: typeid
+              pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+              type: string
+              x-typeid-prefix: tag
+            maxItems: 1000
+            type: array
+          - type: 'null'
+          description: Tag IDs to set as the complete tag set for the objects, replacing
+            any existing tags. Mutually exclusive with 'add' and 'remove'. An empty
+            list removes all tags.
+          title: Replace
+        type:
+          $ref: '#/components/schemas/TagType'
+          description: The object/tag type (e.g. DOMAIN, CONTACT, ZONE)
+      required:
+      - type
+      - objects
+      title: BulkObjectTagChanges
+      type: object
     CommandError:
       properties:
         error:
@@ -6329,6 +6393,57 @@ components:
       - performed_by_id
       title: ObjectLogSortField
       type: string
+    ObjectTagChanges:
+      properties:
+        add:
+          description: Object TypeIDs or resource names to tag. TypeIDs and names
+            may be mixed.
+          items:
+            description: A TypeID (e.g. domain_01h45ytscbebyvny4gc8cr8ma2) or a resource
+              name (e.g. example.com)
+            examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            - example.com
+            type: string
+          maxItems: 1000
+          title: Add
+          type: array
+        remove:
+          description: Object TypeIDs or resource names to untag. TypeIDs and names
+            may be mixed.
+          items:
+            description: A TypeID (e.g. domain_01h45ytscbebyvny4gc8cr8ma2) or a resource
+              name (e.g. example.com)
+            examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            - example.com
+            type: string
+          maxItems: 1000
+          title: Remove
+          type: array
+      title: ObjectTagChanges
+      type: object
+    ObjectTagChangesResponse:
+      properties:
+        added:
+          description: Number of objects tagged
+          title: Added
+          type: integer
+        removed:
+          description: Number of objects untagged
+          title: Removed
+          type: integer
+        unresolved:
+          description: References that could not be resolved
+          items:
+            type: string
+          title: Unresolved
+          type: array
+      required:
+      - added
+      - removed
+      title: ObjectTagChangesResponse
+      type: object
     Organization:
       properties:
         address_1:
@@ -7309,6 +7424,20 @@ components:
       - pagination
       title: Pagination[RequestHistory]
       type: object
+    Pagination_TagResponse_:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadata'
+        results:
+          items:
+            $ref: '#/components/schemas/TagResponse'
+          title: Results
+          type: array
+      required:
+      - results
+      - pagination
+      title: Pagination[TagResponse]
+      type: object
     Pagination_UserPublic_:
       properties:
         pagination:
@@ -8673,12 +8802,132 @@ components:
       - color-10
       title: TagColor
       type: string
+    TagCreate:
+      properties:
+        color:
+          anyOf:
+          - $ref: '#/components/schemas/TagColor'
+          - type: 'null'
+          default: color-1
+          description: The color of the tag
+        description:
+          anyOf:
+          - maxLength: 1024
+            type: string
+          - type: 'null'
+          description: Optional description of the tag
+          title: Description
+        label:
+          description: A human-readable label for the tag
+          maxLength: 50
+          minLength: 1
+          title: Label
+          type: string
+        type:
+          $ref: '#/components/schemas/TagType'
+          description: Which category a tag applies to, cannot be changed once created
+      required:
+      - label
+      - type
+      title: TagCreate
+      type: object
     TagFilterMode:
       enum:
       - match_any
       - match_all
       title: TagFilterMode
       type: string
+    TagResponse:
+      properties:
+        color:
+          $ref: '#/components/schemas/TagColor'
+          description: The color of the tag
+        created_on:
+          description: The date/time the tag was created on
+          format: date-time
+          title: Created On
+          type: string
+        description:
+          anyOf:
+          - maxLength: 1024
+            type: string
+          - type: 'null'
+          description: Optional description of the tag
+          title: Description
+        label:
+          description: The label of the tag
+          minLength: 1
+          title: Label
+          type: string
+        object_count:
+          default: 0
+          description: Number of objects tagged with this tag
+          title: Object Count
+          type: integer
+        tag_id:
+          description: The unique identifier of the tag
+          examples:
+          - tag_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Tag Id
+          type: string
+          x-typeid-prefix: tag
+        type:
+          $ref: '#/components/schemas/TagType'
+          description: Which category a tag applies to, cannot be changed once created
+        updated_on:
+          description: The date/time the tag was last updated on
+          format: date-time
+          title: Updated On
+          type: string
+      required:
+      - tag_id
+      - label
+      - type
+      - color
+      - created_on
+      - updated_on
+      title: TagResponse
+      type: object
+    TagSortField:
+      enum:
+      - label
+      - created_on
+      - updated_on
+      title: TagSortField
+      type: string
+    TagType:
+      enum:
+      - DOMAIN
+      - CONTACT
+      - ZONE
+      title: TagType
+      type: string
+    TagUpdate:
+      properties:
+        color:
+          anyOf:
+          - $ref: '#/components/schemas/TagColor'
+          - type: 'null'
+          description: The color of the tag
+        description:
+          anyOf:
+          - maxLength: 1024
+            type: string
+          - type: 'null'
+          description: Optional description of the tag
+          title: Description
+        label:
+          anyOf:
+          - maxLength: 50
+            minLength: 1
+            type: string
+          - type: 'null'
+          description: A human-readable label for the tag
+          title: Label
+      title: TagUpdate
+      type: object
     TimeRange:
       enum:
       - 1h
@@ -9765,6 +10014,12 @@ components:
         available:
           title: Available
           type: boolean
+        claim_key:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Claim key, if trademark notice acceptance is required
+          title: Claim Key
         domain:
           description: The domain name
           examples:
@@ -9863,7 +10118,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-20-173548
+  version: 2026-04-21-143327
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -21105,6 +21360,472 @@ paths:
       summary: Download Report
       tags:
       - report
+  /v1/tags:
+    get:
+      description: Retrieves a paginated list of tags
+      operationId: list_tags_v1_tags_get
+      parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/TagSortField'
+          default: label
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: asc
+      - description: Filter by tag types (OR semantics)
+        in: query
+        name: tag_types
+        required: false
+        schema:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/TagType'
+            type: array
+          - type: 'null'
+          description: Filter by tag types (OR semantics)
+          title: Tag Types
+      - in: query
+        name: search
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Search
+      - 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: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_TagResponse_'
+          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: []
+      - APIKeyHeader: []
+      summary: List tags
+      tags:
+      - tag
+    post:
+      description: Create a new tag
+      operationId: create_tag_v1_tags_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/TagCreate'
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TagResponse'
+          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
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_TAG_LABEL_ALREADY_EXISTS
+                detail: A tag with label 'Additional error context.' already exists
+                label: Additional error context.
+                status: 409
+                title: Tag Management Error
+                type: tag-label-already-exists
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Conflict
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Create a tag
+      tags:
+      - tag
+  /v1/tags/objects:
+    post:
+      description: Add, remove, or replace tags on multiple objects at once. 'replace'
+        is mutually exclusive with 'add' and 'remove'.
+      operationId: bulk_update_object_tags_v1_tags_objects_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/BulkObjectTagChanges'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ObjectTagChangesResponse'
+          description: Successful Response
+        '400':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_ILLEGAL_OBJECT_TYPE_FOR_TAG
+                detail: One or more provided object ids are not valid for this tag
+                object_ids: Additional error context.
+                status: 400
+                title: Tag Management Error
+                type: illegal-object-type-tag
+              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_TAG_NOT_FOUND
+                detail: Tag not found
+                status: 404
+                tag_id: Additional error context.
+                title: Tag Management Error
+                type: tag-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: []
+      - APIKeyHeader: []
+      summary: Bulk tag or untag objects
+      tags:
+      - tag
+  /v1/tags/{tag_id}:
+    delete:
+      description: Delete a tag
+      operationId: delete_tag_v1_tags__tag_id__delete
+      parameters:
+      - in: path
+        name: tag_id
+        required: true
+        schema:
+          examples:
+          - tag_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Tag Id
+          type: string
+          x-typeid-prefix: tag
+      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
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_TAG_NOT_FOUND
+                detail: Tag not found
+                status: 404
+                tag_id: Additional error context.
+                title: Tag Management Error
+                type: tag-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: []
+      - APIKeyHeader: []
+      summary: Delete a tag
+      tags:
+      - tag
+    get:
+      description: Retrieve a single tag by its ID
+      operationId: get_tag_v1_tags__tag_id__get
+      parameters:
+      - in: path
+        name: tag_id
+        required: true
+        schema:
+          examples:
+          - tag_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Tag Id
+          type: string
+          x-typeid-prefix: tag
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TagResponse'
+          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_TAG_NOT_FOUND
+                detail: Tag not found
+                status: 404
+                tag_id: Additional error context.
+                title: Tag Management Error
+                type: tag-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: []
+      - APIKeyHeader: []
+      summary: Get a tag
+      tags:
+      - tag
+    patch:
+      description: Update a tag's label, description, or color
+      operationId: update_tag_v1_tags__tag_id__patch
+      parameters:
+      - in: path
+        name: tag_id
+        required: true
+        schema:
+          examples:
+          - tag_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Tag Id
+          type: string
+          x-typeid-prefix: tag
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/TagUpdate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TagResponse'
+          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_TAG_NOT_FOUND
+                detail: Tag not found
+                status: 404
+                tag_id: Additional error context.
+                title: Tag Management Error
+                type: tag-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_TAG_LABEL_ALREADY_EXISTS
+                detail: A tag with label 'Additional error context.' already exists
+                label: Additional error context.
+                status: 409
+                title: Tag Management Error
+                type: tag-label-already-exists
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Conflict
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Update a tag
+      tags:
+      - tag
+  /v1/tags/{tag_id}/objects:
+    post:
+      description: Add or remove objects from a tag. Objects are matched by the tag's
+        type (e.g. a DOMAIN tag only accepts domain IDs).
+      operationId: update_tag_objects_v1_tags__tag_id__objects_post
+      parameters:
+      - in: path
+        name: tag_id
+        required: true
+        schema:
+          examples:
+          - tag_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Tag Id
+          type: string
+          x-typeid-prefix: tag
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ObjectTagChanges'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ObjectTagChangesResponse'
+          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_TAG_NOT_FOUND
+                detail: Tag not found
+                status: 404
+                tag_id: Additional error context.
+                title: Tag Management Error
+                type: tag-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: []
+      - APIKeyHeader: []
+      summary: Tag or untag objects
+      tags:
+      - tag
   /v1/tlds/:
     get:
       description: Retrieves a list of TLD Specifications we have support for