@opusdns/api 0.199.0 → 0.201.0

package/src/openapi.yaml

@@ -306,6 +306,185 @@ components:
       - type
       title: ContactAttributeDefinition
       type: object
+    ContactAttributeLinkDetail:
+      properties:
+        attributes:
+          additionalProperties:
+            type: string
+          description: The attributes from the linked set
+          propertyNames:
+            $ref: '#/components/schemas/RegistryHandleAttributeType'
+          title: Attributes
+          type: object
+        contact_attribute_set_id:
+          description: The attribute set linked to the contact
+          examples:
+          - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Set Id
+          type: string
+          x-typeid-prefix: contact_attribute_set
+        label:
+          description: The label of the linked attribute set
+          title: Label
+          type: string
+        tld:
+          description: The TLD this link applies to
+          title: Tld
+          type: string
+      required:
+      - contact_attribute_set_id
+      - label
+      - tld
+      - attributes
+      title: ContactAttributeLinkDetail
+      type: object
+    ContactAttributeLinkResponse:
+      properties:
+        contact_attribute_link_id:
+          description: The unique identifier of the link
+          examples:
+          - contact_attribute_link_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_link_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Link Id
+          type: string
+          x-typeid-prefix: contact_attribute_link
+        contact_attribute_set_id:
+          description: The attribute set linked to the contact
+          examples:
+          - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Set Id
+          type: string
+          x-typeid-prefix: contact_attribute_set
+        contact_id:
+          description: The contact this link belongs to
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Id
+          type: string
+          x-typeid-prefix: contact
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        tld:
+          description: The TLD this link applies to
+          title: Tld
+          type: string
+      required:
+      - contact_attribute_link_id
+      - contact_id
+      - contact_attribute_set_id
+      - tld
+      - created_on
+      title: ContactAttributeLinkResponse
+      type: object
+    ContactAttributeSetCreate:
+      properties:
+        attributes:
+          additionalProperties:
+            type: string
+          description: Key-value map of contact attributes for this set
+          propertyNames:
+            $ref: '#/components/schemas/RegistryHandleAttributeType'
+          title: Attributes
+          type: object
+        label:
+          description: A human-readable label explaining the purpose of this attribute
+            set
+          maxLength: 255
+          minLength: 1
+          title: Label
+          type: string
+        tld:
+          description: The TLD this attribute set applies to (e.g. 'de', '.de', 'DE')
+          title: Tld
+          type: string
+      required:
+      - label
+      - attributes
+      - tld
+      title: ContactAttributeSetCreate
+      type: object
+    ContactAttributeSetResponse:
+      properties:
+        attributes:
+          additionalProperties:
+            type: string
+          description: Key-value map of contact attributes for this set
+          propertyNames:
+            $ref: '#/components/schemas/RegistryHandleAttributeType'
+          title: Attributes
+          type: object
+        contact_attribute_set_id:
+          description: The unique identifier of the attribute set
+          examples:
+          - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Set Id
+          type: string
+          x-typeid-prefix: contact_attribute_set
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        label:
+          description: A human-readable label explaining the purpose of this attribute
+            set
+          maxLength: 255
+          minLength: 1
+          title: Label
+          type: string
+        organization_id:
+          description: The organization that owns this attribute set
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+        tld:
+          description: The TLD this attribute set applies to
+          title: Tld
+          type: string
+        updated_on:
+          description: The date/time the entry was last updated on
+          format: date-time
+          title: Updated On
+          type: string
+      required:
+      - label
+      - attributes
+      - contact_attribute_set_id
+      - organization_id
+      - tld
+      - created_on
+      - updated_on
+      title: ContactAttributeSetResponse
+      type: object
+    ContactAttributeSetUpdate:
+      properties:
+        label:
+          anyOf:
+          - maxLength: 255
+            minLength: 1
+            type: string
+          - type: 'null'
+          description: A human-readable label explaining the purpose of this attribute
+            set
+          title: Label
+      title: ContactAttributeSetUpdate
+      type: object
     ContactConfigBase:
       properties:
         max:
@@ -417,6 +596,132 @@ components:
       - disclose
       title: ContactCreate
       type: object
+    ContactDetailResponse:
+      properties:
+        attribute_sets:
+          description: Linked attribute sets for this contact
+          items:
+            $ref: '#/components/schemas/ContactAttributeLinkDetail'
+          title: Attribute Sets
+          type: array
+        city:
+          description: The city of the contact
+          minLength: 1
+          title: City
+          type: string
+        contact_id:
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Id
+          type: string
+          x-typeid-prefix: contact
+        country:
+          description: The country of the contact
+          pattern: ^\w{2}$
+          title: Country
+          type: string
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        deleted_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date/time the entry was deleted on
+          title: Deleted On
+        disclose:
+          description: Whether the contact details should be disclosed. The Disclose
+            function may not work with all TLDs. Some registries still display the
+            data in Whois if, for example, the organization field is filled in.
+          title: Disclose
+          type: boolean
+        email:
+          description: The email of the contact
+          format: email
+          title: Email
+          type: string
+        fax:
+          anyOf:
+          - format: phone
+            type: string
+          - type: 'null'
+          description: The contacts's fax number
+          title: Fax
+        first_name:
+          description: The first name of the contact
+          minLength: 1
+          title: First Name
+          type: string
+        last_name:
+          description: The last name of the contact
+          minLength: 1
+          title: Last Name
+          type: string
+        org:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          description: The organization of the contact
+          title: Org
+        organization_id:
+          default: None
+          description: The organization that owns the domain
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+        phone:
+          description: The contact's phone number
+          examples:
+          - '+1.2125552368'
+          format: phone
+          title: Phone
+          type: string
+        postal_code:
+          description: The postal code of the contact
+          minLength: 1
+          title: Postal Code
+          type: string
+        state:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          description: The state of the contact
+          title: State
+        street:
+          description: The address of the contact
+          minLength: 1
+          title: Street
+          type: string
+        title:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          description: The title of the contact
+          title: Title
+      required:
+      - first_name
+      - last_name
+      - email
+      - phone
+      - street
+      - city
+      - postal_code
+      - country
+      - disclose
+      title: ContactDetailResponse
+      type: object
     ContactHandle:
       properties:
         attributes:
@@ -4788,19 +5093,33 @@ components:
       - pagination
       title: Pagination[BillingTransactionResponse]
       type: object
-    Pagination_ContactSchema_:
+    Pagination_ContactAttributeSetResponse_:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadata'
+        results:
+          items:
+            $ref: '#/components/schemas/ContactAttributeSetResponse'
+          title: Results
+          type: array
+      required:
+      - results
+      - pagination
+      title: Pagination[ContactAttributeSetResponse]
+      type: object
+    Pagination_ContactDetailResponse_:
       properties:
         pagination:
           $ref: '#/components/schemas/PaginationMetadata'
         results:
           items:
-            $ref: '#/components/schemas/ContactSchema'
+            $ref: '#/components/schemas/ContactDetailResponse'
           title: Results
           type: array
       required:
       - results
       - pagination
-      title: Pagination[ContactSchema]
+      title: Pagination[ContactDetailResponse]
       type: object
     Pagination_DnsZoneResponse_:
       properties:
@@ -7031,7 +7350,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-02-20-105000
+  version: 2026-02-24-090615
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7937,7 +8256,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Pagination_ContactSchema_'
+                $ref: '#/components/schemas/Pagination_ContactDetailResponse_'
           description: Successful Response
         '422':
           content:
@@ -7979,6 +8298,252 @@ paths:
       summary: Create a contact
       tags:
       - contact
+  /v1/contacts/attribute-sets:
+    get:
+      operationId: list_attribute_sets_v1_contacts_attribute_sets_get
+      parameters:
+      - description: Filter by TLD (e.g. 'de', '.de', 'DE')
+        in: query
+        name: tld
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Filter by TLD (e.g. 'de', '.de', 'DE')
+          title: Tld
+      - 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_ContactAttributeSetResponse_'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: List contact attribute sets
+      tags:
+      - contact
+    post:
+      operationId: create_attribute_set_v1_contacts_attribute_sets_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ContactAttributeSetCreate'
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ContactAttributeSetResponse'
+          description: Successful Response
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_ATTRIBUTE_SET_LABEL_ALREADY_EXISTS
+                detail: A contact attribute set with label 'Additional error context.'
+                  already exists
+                label: Additional error context.
+                status: 409
+                title: Contact Attribute Set Error
+                type: contact-attribute-set-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 contact attribute set
+      tags:
+      - contact
+  /v1/contacts/attribute-sets/{contact_attribute_set_id}:
+    delete:
+      operationId: delete_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__delete
+      parameters:
+      - in: path
+        name: contact_attribute_set_id
+        required: true
+        schema:
+          examples:
+          - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Set Id
+          type: string
+          x-typeid-prefix: contact_attribute_set
+      responses:
+        '204':
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_ATTRIBUTE_SET_NOT_FOUND
+                contact_attribute_set_id: Additional error context.
+                detail: Contact attribute set not found
+                status: 404
+                title: Contact Attribute Set Error
+                type: contact-attribute-set-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 contact attribute set
+      tags:
+      - contact
+    get:
+      operationId: get_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__get
+      parameters:
+      - in: path
+        name: contact_attribute_set_id
+        required: true
+        schema:
+          examples:
+          - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Set Id
+          type: string
+          x-typeid-prefix: contact_attribute_set
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ContactAttributeSetResponse'
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_ATTRIBUTE_SET_NOT_FOUND
+                contact_attribute_set_id: Additional error context.
+                detail: Contact attribute set not found
+                status: 404
+                title: Contact Attribute Set Error
+                type: contact-attribute-set-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: Retrieve a contact attribute set
+      tags:
+      - contact
+    patch:
+      operationId: update_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__patch
+      parameters:
+      - in: path
+        name: contact_attribute_set_id
+        required: true
+        schema:
+          examples:
+          - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Set Id
+          type: string
+          x-typeid-prefix: contact_attribute_set
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ContactAttributeSetUpdate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ContactAttributeSetResponse'
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_ATTRIBUTE_SET_NOT_FOUND
+                contact_attribute_set_id: Additional error context.
+                detail: Contact attribute set not found
+                status: 404
+                title: Contact Attribute Set Error
+                type: contact-attribute-set-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_ATTRIBUTE_SET_LABEL_ALREADY_EXISTS
+                detail: A contact attribute set with label 'Additional error context.'
+                  already exists
+                label: Additional error context.
+                status: 409
+                title: Contact Attribute Set Error
+                type: contact-attribute-set-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 contact attribute set
+      tags:
+      - contact
   /v1/contacts/verification:
     get:
       operationId: get_verification_by_token_v1_contacts_verification_get
@@ -8174,7 +8739,6 @@ paths:
       tags:
       - contact
     get:
-      description: Retrieves a contact object
       operationId: get_contact_v1_contacts__contact_id__get
       parameters:
       - in: path
@@ -8193,7 +8757,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ContactSchema'
+                $ref: '#/components/schemas/ContactDetailResponse'
           description: Successful Response
         '404':
           content:
@@ -8220,6 +8784,89 @@ paths:
       summary: Retrieve a contact
       tags:
       - contact
+  /v1/contacts/{contact_id}/link/{contact_attribute_set_id}:
+    patch:
+      operationId: create_attribute_link_v1_contacts__contact_id__link__contact_attribute_set_id__patch
+      parameters:
+      - in: path
+        name: contact_id
+        required: true
+        schema:
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Id
+          type: string
+          x-typeid-prefix: contact
+      - in: path
+        name: contact_attribute_set_id
+        required: true
+        schema:
+          examples:
+          - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Attribute Set Id
+          type: string
+          x-typeid-prefix: contact_attribute_set
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ContactAttributeLinkResponse'
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              examples:
+                Contact Attribute Set Error:
+                  value:
+                    code: ERROR_CONTACT_ATTRIBUTE_SET_NOT_FOUND
+                    contact_attribute_set_id: Additional error context.
+                    detail: Contact attribute set not found
+                    status: 404
+                    title: Contact Attribute Set Error
+                    type: contact-attribute-set-not-found
+                Contact Management Error:
+                  value:
+                    code: ERROR_CONTACT_NOT_FOUND
+                    contact_id: Additional error context.
+                    detail: Contact not found
+                    status: 404
+                    title: Contact Management Error
+                    type: contact-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_ATTRIBUTE_LINK_ALREADY_EXISTS
+                contact_id: Additional error context.
+                detail: A contact attribute link already exists for this contact and
+                  TLD
+                status: 409
+                title: Contact Attribute Set Error
+                tld: ''
+                type: contact-attribute-link-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: Link a contact to a contact attribute set
+      tags:
+      - contact
   /v1/contacts/{contact_id}/verification:
     delete:
       operationId: cancel_verification_v1_contacts__contact_id__verification_delete