@opusdns/api 1.5.0 → 1.7.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.2.0"
   },
   "name": "@opusdns/api",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -1,5 +1,6 @@
 import type {
   AllocationMethodType,
+  AssignablePublicRole,
   AttributeType,
   BatchSortField,
   BatchStatus,
@@ -118,6 +119,22 @@ export const ALLOCATION_METHOD_TYPE_VALUES = [
   'lottery',
 ] as const satisfies ReadonlyArray<AllocationMethodType>;
 
+export const ASSIGNABLE_PUBLIC_ROLE = {
+  ADMIN: "admin",
+  VIEWER: "viewer",
+  DOMAIN_MANAGER: "domain_manager",
+  DNS_MANAGER: "dns_manager",
+  BILLING_MANAGER: "billing_manager",
+} as const satisfies Record<string, AssignablePublicRole>;
+
+export const ASSIGNABLE_PUBLIC_ROLE_VALUES = [
+  'admin',
+  'viewer',
+  'domain_manager',
+  'dns_manager',
+  'billing_manager',
+] as const satisfies ReadonlyArray<AssignablePublicRole>;
+
 export const ATTRIBUTE_TYPE = {
   ENUM: "enum",
   STRING: "string",
@@ -1355,6 +1372,7 @@ export const PUBLIC_RESOURCE_VALUES = [
 ] as const satisfies ReadonlyArray<PublicResource>;
 
 export const PUBLIC_ROLE = {
+  OWNER: "owner",
   ADMIN: "admin",
   VIEWER: "viewer",
   DOMAIN_MANAGER: "domain_manager",
@@ -1363,6 +1381,7 @@ export const PUBLIC_ROLE = {
 } as const satisfies Record<string, PublicRole>;
 
 export const PUBLIC_ROLE_VALUES = [
+  'owner',
   'admin',
   'viewer',
   'domain_manager',

package/src/helpers/keys.ts

@@ -265,6 +265,7 @@ import type {
   PublicReportListRes,
   PublicReportRes,
   PublicRoleAssignment,
+  PublicRoleAssignmentRequest,
   RdapBase,
   ReferrerStatsBucket,
   RegistryLockBase,
@@ -3725,6 +3726,12 @@ export const KEYS_PUBLIC_ROLE_ASSIGNMENT = [
   KEY_PUBLIC_ROLE_ASSIGNMENT_ROLE,
 ] as const satisfies (keyof PublicRoleAssignment)[];
 
+export const KEY_PUBLIC_ROLE_ASSIGNMENT_REQUEST_ROLE = 'role' satisfies keyof PublicRoleAssignmentRequest;
+
+export const KEYS_PUBLIC_ROLE_ASSIGNMENT_REQUEST = [
+  KEY_PUBLIC_ROLE_ASSIGNMENT_REQUEST_ROLE,
+] as const satisfies (keyof PublicRoleAssignmentRequest)[];
+
 export const KEY_RDAP_BASE_RDAP_SERVER = 'rdap_server' satisfies keyof RdapBase;
 
 export const KEYS_RDAP_BASE = [

package/src/helpers/requests.d.ts

@@ -42,7 +42,7 @@ import type {
   ParkingSignupRequest,
   PasswordUpdate,
   PublicAuthRequestForm,
-  PublicRoleAssignment,
+  PublicRoleAssignmentRequest,
   TagCreate,
   TagUpdate,
   UserCreate,
@@ -953,7 +953,7 @@ export type GET_UsersByUserIdRole_Request_Path = GET_UsersByUserIdRole_Request['
 
 export type PUT_UsersByUserIdRole_Request = {
   parameters: operations['set_user_role_v1_users__user_id__role_put']['parameters'];
-  requestBody: PublicRoleAssignment;
+  requestBody: PublicRoleAssignmentRequest;
 };
 export type PUT_UsersByUserIdRole_Request_Path = PUT_UsersByUserIdRole_Request['parameters']['path'];
 export type PUT_UsersByUserIdRole_Request_Body = PUT_UsersByUserIdRole_Request['requestBody'];

package/src/helpers/responses.d.ts

@@ -1197,7 +1197,8 @@ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 = Pro
 export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 = Problem;
 export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTTPValidationError;
 
-export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_422;
+export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_403 | PUT_UsersByUserIdRole_Response_422;
 
 export type PUT_UsersByUserIdRole_Response_200 = PublicRoleAssignment;
+export type PUT_UsersByUserIdRole_Response_403 = Problem;
 export type PUT_UsersByUserIdRole_Response_422 = HTTPValidationError;

package/src/helpers/schemas.d.ts

@@ -2,6 +2,7 @@ import { components } from '../schema';
 
 export type AllocationMethodType = components['schemas']['AllocationMethodType'];
 export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumberOfNameserverBase'];
+export type AssignablePublicRole = components['schemas']['AssignablePublicRole'];
 export type AttributeCondition = components['schemas']['AttributeCondition'];
 export type AttributeType = components['schemas']['AttributeType'];
 export type BatchSortField = components['schemas']['BatchSortField'];
@@ -370,6 +371,7 @@ export type PublicReportRes = components['schemas']['PublicReportRes'];
 export type PublicResource = components['schemas']['PublicResource'];
 export type PublicRole = components['schemas']['PublicRole'];
 export type PublicRoleAssignment = components['schemas']['PublicRoleAssignment'];
+export type PublicRoleAssignmentRequest = components['schemas']['PublicRoleAssignmentRequest'];
 export type PublicScope = components['schemas']['PublicScope'];
 export type RdapBase = components['schemas']['RdapBase'];
 export type RedirectCode = components['schemas']['RedirectCode'];

package/src/openapi.yaml

@@ -23,6 +23,15 @@ components:
       - max
       title: AllowedNumberOfNameserverBase
       type: object
+    AssignablePublicRole:
+      enum:
+      - admin
+      - viewer
+      - domain_manager
+      - dns_manager
+      - billing_manager
+      title: AssignablePublicRole
+      type: string
     AttributeCondition:
       properties:
         field:
@@ -9449,6 +9458,7 @@ components:
       type: string
     PublicRole:
       enum:
+      - owner
       - admin
       - viewer
       - domain_manager
@@ -9464,6 +9474,14 @@ components:
           - type: 'null'
       title: PublicRoleAssignment
       type: object
+    PublicRoleAssignmentRequest:
+      properties:
+        role:
+          anyOf:
+          - $ref: '#/components/schemas/AssignablePublicRole'
+          - type: 'null'
+      title: PublicRoleAssignmentRequest
+      type: object
     PublicScope:
       enum:
       - read
@@ -11537,7 +11555,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-06-10-074321
+  version: 2026-06-10-102008
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -12817,6 +12835,8 @@ paths:
       summary: Retrieve email forward logs by alias
       tags:
       - archive
+      x-required-permissions:
+      - email_forwards:read
   /v1/archive/email-forward-logs/{email_forward_id}:
     get:
       description: Retrieves a paginated list of email forward logs for a specific
@@ -12908,6 +12928,8 @@ paths:
       summary: Retrieve email forward logs
       tags:
       - archive
+      x-required-permissions:
+      - email_forwards:read
   /v1/archive/object-logs:
     get:
       description: Retrieve all paginated audit logs with optional filtering and sorting
@@ -13708,6 +13730,8 @@ paths:
       summary: List all contacts
       tags:
       - contact
+      x-required-permissions:
+      - contacts:read
     post:
       description: Create a new contact object to use for domain registration
       operationId: create_contact_v1_contacts_post
@@ -13736,6 +13760,8 @@ paths:
       summary: Create a contact
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
   /v1/contacts/attribute-sets:
     get:
       operationId: list_attribute_sets_v1_contacts_attribute_sets_get
@@ -13804,6 +13830,8 @@ paths:
       summary: List contact attribute sets
       tags:
       - contact
+      x-required-permissions:
+      - contacts:read
     post:
       operationId: create_attribute_set_v1_contacts_attribute_sets_post
       requestBody:
@@ -13845,6 +13873,8 @@ paths:
       summary: Create a contact attribute set
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
   /v1/contacts/attribute-sets/{contact_attribute_set_id}:
     delete:
       operationId: delete_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__delete
@@ -13888,6 +13918,8 @@ paths:
       summary: Delete a contact attribute set
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
     get:
       operationId: get_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__get
       parameters:
@@ -13934,6 +13966,8 @@ paths:
       summary: Retrieve a contact attribute set
       tags:
       - contact
+      x-required-permissions:
+      - contacts:read
     patch:
       operationId: update_attribute_set_v1_contacts_attribute_sets__contact_attribute_set_id__patch
       parameters:
@@ -14000,6 +14034,8 @@ paths:
       summary: Update a contact attribute set
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
   /v1/contacts/verification:
     get:
       operationId: get_verification_by_token_v1_contacts_verification_get
@@ -14194,6 +14230,8 @@ paths:
       summary: Delete a contact
       tags:
       - contact
+      x-required-permissions:
+      - contacts:delete
     get:
       operationId: get_contact_v1_contacts__contact_id__get
       parameters:
@@ -14250,6 +14288,8 @@ paths:
       summary: Retrieve a contact
       tags:
       - contact
+      x-required-permissions:
+      - contacts:read
   /v1/contacts/{contact_id}/link/{contact_attribute_set_id}:
     patch:
       operationId: create_attribute_link_v1_contacts__contact_id__link__contact_attribute_set_id__patch
@@ -14333,6 +14373,8 @@ paths:
       summary: Link a contact to a contact attribute set
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
   /v1/contacts/{contact_id}/verification:
     delete:
       operationId: cancel_verification_v1_contacts__contact_id__verification_delete
@@ -14388,6 +14430,8 @@ paths:
       summary: Delete contact verification
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
     get:
       operationId: get_verification_status_v1_contacts__contact_id__verification_get
       parameters:
@@ -14446,6 +14490,8 @@ paths:
       summary: Retrieve contact verification by contact ID
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
     post:
       operationId: start_contact_verification_v1_contacts__contact_id__verification_post
       parameters:
@@ -14525,6 +14571,8 @@ paths:
       summary: Start contact verification
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
     put:
       operationId: update_verification_v1_contacts__contact_id__verification_put
       parameters:
@@ -14613,6 +14661,8 @@ paths:
       summary: Complete contact verification by contact ID
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
   /v1/contacts/{contact_id}/verifications:
     get:
       description: Retrieve the current verification state for a contact from the
@@ -14686,6 +14736,8 @@ paths:
       summary: Get contact verification status
       tags:
       - contact
+      x-required-permissions:
+      - contacts:read
   /v1/contacts/{contact_id}/verifications/attest:
     post:
       description: Submit one or more contact-verification attestations. Returns the
@@ -14780,6 +14832,8 @@ paths:
       summary: Attest a contact verification
       tags:
       - contact
+      x-required-permissions:
+      - contacts:manage
   /v1/dns:
     get:
       operationId: list_zones_v1_dns_get
@@ -14977,6 +15031,8 @@ paths:
       summary: List Zones
       tags:
       - dns
+      x-required-permissions:
+      - dns:read
     post:
       operationId: create_zone_v1_dns_post
       requestBody:
@@ -15231,6 +15287,8 @@ paths:
       summary: Create Zone
       tags:
       - dns
+      x-required-permissions:
+      - dns:manage
   /v1/dns/domain-forwards:
     get:
       description: Retrieves a paginated list of domain forwards grouped by DNS zones.
@@ -15350,6 +15408,8 @@ paths:
       summary: List domain forwards by zone
       tags:
       - dns
+      x-required-permissions:
+      - dns:read
   /v1/dns/email-forwards:
     get:
       description: Retrieves a paginated list of email forwards grouped by DNS zones.
@@ -15435,6 +15495,8 @@ paths:
       summary: List email forwards by zone
       tags:
       - dns
+      x-required-permissions:
+      - dns:read
   /v1/dns/summary:
     get:
       operationId: get_zones_summary_v1_dns_summary_get
@@ -15466,6 +15528,8 @@ paths:
       summary: Get Zones Summary
       tags:
       - dns
+      x-required-permissions:
+      - dns:read
   /v1/dns/{zone_name}:
     delete:
       operationId: delete_zone_v1_dns__zone_name__delete
@@ -15493,6 +15557,8 @@ paths:
       summary: Delete Zone
       tags:
       - dns
+      x-required-permissions:
+      - dns:delete
     get:
       operationId: get_zone_v1_dns__zone_name__get
       parameters:
@@ -15533,6 +15599,8 @@ paths:
       summary: Get Zone
       tags:
       - dns
+      x-required-permissions:
+      - dns:read
   /v1/dns/{zone_name}/dnssec/disable:
     post:
       operationId: disable_dnssec_v1_dns__zone_name__dnssec_disable_post
@@ -15619,6 +15687,8 @@ paths:
       summary: Disable Dnssec
       tags:
       - dns
+      x-required-permissions:
+      - dns:manage
   /v1/dns/{zone_name}/dnssec/enable:
     post:
       operationId: enable_dnssec_v1_dns__zone_name__dnssec_enable_post
@@ -15705,6 +15775,8 @@ paths:
       summary: Enable Dnssec
       tags:
       - dns
+      x-required-permissions:
+      - dns:manage
   /v1/dns/{zone_name}/domain-forwards:
     get:
       description: Retrieves all domain forwards configured for the specified DNS
@@ -15788,6 +15860,8 @@ paths:
       summary: List domain forwards for a zone
       tags:
       - dns
+      x-required-permissions:
+      - dns:read
   /v1/dns/{zone_name}/email-forwards:
     get:
       description: Retrieves all email forwards configured for the specified DNS zone,
@@ -15845,6 +15919,8 @@ paths:
       summary: List email forwards for a zone
       tags:
       - dns
+      x-required-permissions:
+      - dns:read
   /v1/dns/{zone_name}/records:
     patch:
       operationId: patch_zone_records_v1_dns__zone_name__records_patch
@@ -15944,6 +16020,8 @@ paths:
       summary: Patch Zone Records
       tags:
       - dns
+      x-required-permissions:
+      - dns:manage
   /v1/dns/{zone_name}/rrsets:
     patch:
       operationId: patch_zone_rrsets_v1_dns__zone_name__rrsets_patch
@@ -16089,6 +16167,8 @@ paths:
       summary: Patch Zone Rrsets
       tags:
       - dns
+      x-required-permissions:
+      - dns:manage
     put:
       operationId: update_zone_rrsets_v1_dns__zone_name__rrsets_put
       parameters:
@@ -16221,6 +16301,8 @@ paths:
       summary: Update Zone Rrsets
       tags:
       - dns
+      x-required-permissions:
+      - dns:manage
   /v1/domain-forwards:
     get:
       description: Retrieves a paginated list of domain forwards by hostname for the
@@ -16404,6 +16486,8 @@ paths:
       summary: List domain forwards
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
     patch:
       description: Applies patch operations to update or remove redirects across hostnames
         and protocols. Raises an error if the domain forward or domain forward set
@@ -16466,6 +16550,8 @@ paths:
       summary: Patch domain forward redirects
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:manage
     post:
       description: Creates a new domain forward configuration. Wildcard forwards can
         be created by using *.hostname (e.g., *.example.com).
@@ -16641,6 +16727,8 @@ paths:
       summary: Create a domain forward
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:manage
   /v1/domain-forwards/metrics:
     get:
       description: Retrieves overall metrics for domain forwards including total and
@@ -16759,6 +16847,8 @@ paths:
       summary: Get domain forward metrics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/browser:
     get:
       description: Retrieves visitor traffic broken down by browser type (Chrome,
@@ -16900,6 +16990,8 @@ paths:
       summary: Get browser statistics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/geo:
     get:
       description: Retrieves visitor traffic broken down by geographic location (country
@@ -17034,6 +17126,8 @@ paths:
       summary: Get geographic statistics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/platform:
     get:
       description: Retrieves visitor traffic broken down by platform (Windows, Macintosh,
@@ -17173,6 +17267,8 @@ paths:
       summary: Get platform statistics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/referrer:
     get:
       description: Retrieves visitor referral sources (where traffic came from) with
@@ -17314,6 +17410,8 @@ paths:
       summary: Get referrer statistics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/status-code:
     get:
       description: Retrieves distribution of HTTP redirect status codes (301, 302,
@@ -17441,6 +17539,8 @@ paths:
       summary: Get HTTP status code statistics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/time-series:
     get:
       description: Retrieves visit counts bucketed by time intervals (hourly, daily)
@@ -17614,6 +17714,8 @@ paths:
       summary: Get domain forward time series metrics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/user-agent:
     get:
       description: Retrieves visitor traffic broken down by user agent string with
@@ -17747,6 +17849,8 @@ paths:
       summary: Get user agent statistics
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/metrics/visits-by-key:
     get:
       description: Retrieves visit metrics grouped by a specified key (url, fqdn,
@@ -17901,6 +18005,8 @@ paths:
       summary: Get visits grouped by key
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
   /v1/domain-forwards/{hostname}:
     delete:
       description: Deletes the domain forward configuration for the specified hostname
@@ -17965,6 +18071,8 @@ paths:
       summary: Delete a domain forward
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:delete
     get:
       description: Retrieves the domain forward configuration for the specified hostname
       operationId: get_domain_forward_v1_domain_forwards__hostname__get
@@ -18067,6 +18175,8 @@ paths:
       summary: Get a domain forward
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
     post:
       description: Creates a new domain forward set for a specific protocol (HTTP
         or HTTPS). Raises an error if the set already exists.
@@ -18171,6 +18281,8 @@ paths:
       summary: Create domain forward set
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:manage
   /v1/domain-forwards/{hostname}/disable:
     patch:
       description: Disables domain forwarding by removing DNS records. The domain
@@ -18225,6 +18337,8 @@ paths:
       summary: Disable domain forward
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:manage
   /v1/domain-forwards/{hostname}/enable:
     patch:
       description: Enables domain forwarding by creating necessary DNS records
@@ -18278,6 +18392,8 @@ paths:
       summary: Enable domain forward
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:manage
   /v1/domain-forwards/{hostname}/{protocol}:
     delete:
       description: Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
@@ -18348,6 +18464,8 @@ paths:
       summary: Delete domain forward set
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:delete
     get:
       description: Retrieves all redirects for a specific protocol (HTTP or HTTPS)
         for the specified hostname
@@ -18456,6 +18574,8 @@ paths:
       summary: Get domain forward set
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:read
     put:
       description: Updates an existing domain forward set for a specific protocol
         (HTTP or HTTPS). All existing redirects for this protocol are replaced with
@@ -18555,6 +18675,8 @@ paths:
       summary: Update domain forward set
       tags:
       - domain_forward
+      x-required-permissions:
+      - domain_forwards:manage
   /v1/domain-search/suggest:
     get:
       description: Get a list of domain suggestions based on a search query
@@ -18918,6 +19040,8 @@ paths:
       summary: List all domains
       tags:
       - domain
+      x-required-permissions:
+      - domains:read
     post:
       description: 'Registers a new domain.
 
@@ -19035,6 +19159,8 @@ paths:
       summary: Create a domain
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/check:
     get:
       description: 'Performs a real-time check against the authoritative registry
@@ -19122,6 +19248,8 @@ paths:
       summary: Check domain availability and registration metadata
       tags:
       - domain
+      x-required-permissions:
+      - domains:read
   /v1/domains/claims-notices:
     post:
       description: Retrieves the trademark claims notice for a `claims_key` returned
@@ -19181,6 +19309,8 @@ paths:
       summary: Retrieve claims notices from claim keys
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/summary:
     get:
       description: Retrieves a summary of domains including counts by status, TLD,
@@ -19205,6 +19335,8 @@ paths:
       summary: Get domain summary
       tags:
       - domain
+      x-required-permissions:
+      - domains:read
   /v1/domains/tld-specific/at/{domain_reference}/withdraw:
     post:
       operationId: withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post
@@ -19261,6 +19393,8 @@ paths:
       tags:
       - domain
       - domain_tld_specific
+      x-required-permissions:
+      - domains:manage
   /v1/domains/tld-specific/be/{domain_reference}/auth_code/request:
     post:
       operationId: request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post
@@ -19325,6 +19459,8 @@ paths:
       tags:
       - domain
       - domain_tld_specific
+      x-required-permissions:
+      - domains:manage
   /v1/domains/tld-specific/de/{domain_reference}/transit:
     post:
       operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post
@@ -19381,6 +19517,8 @@ paths:
       tags:
       - domain
       - domain_tld_specific
+      x-required-permissions:
+      - domains:manage
   /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request:
     post:
       operationId: request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post
@@ -19445,6 +19583,8 @@ paths:
       tags:
       - domain
       - domain_tld_specific
+      x-required-permissions:
+      - domains:manage
   /v1/domains/transfer:
     post:
       description: 'Start the transfer process for a domain <br>
@@ -19588,6 +19728,8 @@ paths:
       summary: Transfer a domain
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/{domain_reference}:
     delete:
       description: 'Initiates the deletion process for a domain. The domain will be
@@ -19651,6 +19793,8 @@ paths:
       summary: Delete a domain
       tags:
       - domain
+      x-required-permissions:
+      - domains:delete
     get:
       description: Retrieves a single active domain by either its name or id
       operationId: get_domain_v1_domains__domain_reference__get
@@ -19712,6 +19856,8 @@ paths:
       summary: Retrieve a domain
       tags:
       - domain
+      x-required-permissions:
+      - domains:read
     patch:
       description: 'Updates various attributes of an existing domain. Only the fields
         provided in the request
@@ -19783,6 +19929,8 @@ paths:
       summary: Update a domain
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/{domain_reference}/dnssec:
     delete:
       description: Removes all DNSSEC data for a domain
@@ -19829,6 +19977,8 @@ paths:
       summary: Delete DNSSEC data
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
     get:
       description: Fetches all DNSSEC records associated with the specified domain.
       operationId: get_dnssec_v1_domains__domain_reference__dnssec_get
@@ -19881,6 +20031,8 @@ paths:
       summary: Retrieve DNSSEC data
       tags:
       - domain
+      x-required-permissions:
+      - domains:read
     put:
       description: Replaces all existing DNSSEC records for the domain with the provided
         records.
@@ -19950,6 +20102,8 @@ paths:
       summary: Update DNSSEC data
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/{domain_reference}/dnssec/disable:
     post:
       operationId: disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post
@@ -19995,6 +20149,8 @@ paths:
       summary: Disable DNSSEC for domains using our nameservers
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/{domain_reference}/dnssec/enable:
     post:
       operationId: enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post
@@ -20048,6 +20204,8 @@ paths:
       summary: Enable DNSSEC for domains using our nameservers
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/{domain_reference}/renew:
     post:
       description: 'Extends the registration period of an existing domain. The renewal
@@ -20094,6 +20252,8 @@ paths:
       summary: Renew a domain
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/{domain_reference}/restore:
     post:
       operationId: restore_domain_v1_domains__domain_reference__restore_post
@@ -20136,6 +20296,8 @@ paths:
       summary: Restore an eligible domain (during redemption period)
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/domains/{domain_reference}/transfer:
     delete:
       description: This will cancel the in-progress domain transfer and delete the
@@ -20197,6 +20359,8 @@ paths:
       summary: Cancel a domain transfer
       tags:
       - domain
+      x-required-permissions:
+      - domains:manage
   /v1/email-forwards:
     get:
       description: Retrieves a paginated list of all email forwards for the organization.
@@ -20290,6 +20454,8 @@ paths:
       summary: List all email forwards
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:read
     post:
       description: 'Creates an email forward configuration with optional aliases.
         Can be created enabled or disabled (default: disabled). Includes created_on
@@ -20431,6 +20597,9 @@ paths:
       summary: Create email forward configuration
       tags:
       - email_forward
+      x-required-permissions:
+      - dns:manage
+      - email_forwards:manage
   /v1/email-forwards/{email_forward_id}:
     delete:
       description: Permanently deletes the email forward configuration including all
@@ -20488,6 +20657,8 @@ paths:
       summary: Delete email forward configuration
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:delete
     get:
       description: Retrieves the email forward configuration for the specified email
         forward including all aliases
@@ -20559,6 +20730,8 @@ paths:
       summary: Get email forward configuration
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:read
   /v1/email-forwards/{email_forward_id}/aliases:
     post:
       description: Creates a new email forward alias for the specified email forward.
@@ -20684,6 +20857,8 @@ paths:
       summary: Create email forward alias
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:manage
   /v1/email-forwards/{email_forward_id}/aliases/{alias_id}:
     delete:
       description: Deletes a specific email forward alias specified by email_forward_alias_id
@@ -20764,6 +20939,8 @@ paths:
       summary: Delete email forward alias
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:manage
     put:
       description: Updates the forward_to address for a specific email forward alias
         specified by email_forward_alias_id
@@ -20853,6 +21030,8 @@ paths:
       summary: Update email forward alias
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:manage
   /v1/email-forwards/{email_forward_id}/disable:
     patch:
       description: Disables email forwarding by removing MX and SPF DNS records and
@@ -20922,6 +21101,8 @@ paths:
       summary: Disable email forwarding
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:manage
   /v1/email-forwards/{email_forward_id}/enable:
     patch:
       description: Enables email forwarding by creating necessary MX and SPF DNS records
@@ -20990,6 +21171,8 @@ paths:
       summary: Enable email forwarding
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:manage
   /v1/email-forwards/{email_forward_id}/metrics:
     get:
       description: Retrieves metrics and statistics for a specific email forward,
@@ -21080,6 +21263,8 @@ paths:
       summary: Retrieve email forward metrics
       tags:
       - email_forward
+      x-required-permissions:
+      - email_forwards:read
   /v1/events:
     get:
       description: Retrieves a paginated list of events for the organization
@@ -21186,6 +21371,8 @@ paths:
       summary: Get pending events
       tags:
       - event
+      x-required-permissions:
+      - events:read
   /v1/events/{event_id}:
     get:
       description: Get an event by its ID
@@ -21246,6 +21433,8 @@ paths:
       summary: Get event
       tags:
       - event
+      x-required-permissions:
+      - events:read
     patch:
       description: Acknowledge an event
       operationId: acknowledge_event_v1_events__event_id__patch
@@ -21301,6 +21490,8 @@ paths:
       summary: Acknowledge event
       tags:
       - event
+      x-required-permissions:
+      - events:manage
   /v1/job/{job_id}:
     delete:
       operationId: delete_job_v1_job__job_id__delete
@@ -21345,6 +21536,8 @@ paths:
       summary: Delete (cancel) a queued job
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
     get:
       operationId: get_job_v1_job__job_id__get
       parameters:
@@ -21392,6 +21585,8 @@ paths:
       summary: Get individual job details
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:read
   /v1/job/{job_id}/pause:
     post:
       operationId: pause_job_v1_job__job_id__pause_post
@@ -21436,6 +21631,8 @@ paths:
       summary: Pause a job
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
   /v1/job/{job_id}/resume:
     post:
       operationId: resume_job_v1_job__job_id__resume_post
@@ -21484,6 +21681,8 @@ paths:
       summary: Resume a paused job
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
   /v1/job/{job_id}/retry:
     post:
       operationId: retry_job_v1_job__job_id__retry_post
@@ -21544,6 +21743,8 @@ paths:
       summary: Retry a failed or dead-lettered job
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
   /v1/jobs:
     get:
       operationId: list_batches_v1_jobs_get
@@ -21610,6 +21811,8 @@ paths:
       summary: List batches for organization
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:read
     post:
       operationId: create_batch_v1_jobs_post
       requestBody:
@@ -22096,6 +22299,12 @@ paths:
       summary: Create a batch of commands for async execution
       tags:
       - jobs
+      x-required-permissions:
+      - contacts:manage
+      - dns:manage
+      - domains:manage
+      - jobs:manage
+      - parking:manage
   /v1/jobs/{batch_id}:
     delete:
       operationId: delete_batch_v1_jobs__batch_id__delete
@@ -22140,6 +22349,8 @@ paths:
       summary: Delete (cancel) all queued jobs in a batch
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
     get:
       operationId: get_batch_v1_jobs__batch_id__get
       parameters:
@@ -22246,6 +22457,8 @@ paths:
       summary: Get batch details and execution status
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:read
   /v1/jobs/{batch_id}/jobs:
     get:
       operationId: get_batch_jobs_v1_jobs__batch_id__jobs_get
@@ -22529,6 +22742,8 @@ paths:
       summary: Get individual jobs within a batch
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:read
   /v1/jobs/{batch_id}/pause:
     post:
       operationId: pause_batch_v1_jobs__batch_id__pause_post
@@ -22573,6 +22788,8 @@ paths:
       summary: Pause all eligible jobs in a batch
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
   /v1/jobs/{batch_id}/resume:
     post:
       operationId: resume_batch_v1_jobs__batch_id__resume_post
@@ -22617,6 +22834,8 @@ paths:
       summary: Resume all paused jobs in a batch
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
   /v1/jobs/{batch_id}/retry:
     post:
       operationId: retry_batch_v1_jobs__batch_id__retry_post
@@ -22683,6 +22902,8 @@ paths:
       summary: Retry failed and dead-lettered jobs in a batch
       tags:
       - jobs
+      x-required-permissions:
+      - jobs:manage
   /v1/organizations:
     get:
       description: Retrieves a paginated list of organizations under the current organization
@@ -23707,6 +23928,8 @@ paths:
       summary: List all invoices for the organization
       tags:
       - organization
+      x-required-permissions:
+      - billing:manage
   /v1/organizations/{organization_id}/pricing/product-type/{product_type}:
     get:
       description: Retrieves pricing data for a specific product type. If a product
@@ -24117,6 +24340,8 @@ paths:
       summary: List parking entries
       tags:
       - parking
+      x-required-permissions:
+      - parking:read
   /v1/parking/metrics:
     get:
       description: Retrieves aggregated metrics for all parking entries of the organization.
@@ -24183,6 +24408,8 @@ paths:
       summary: Get total metrics for all parking entries
       tags:
       - parking
+      x-required-permissions:
+      - parking:read
   /v1/parking/signup:
     post:
       description: Accept the parking agreement to enable parking features for your
@@ -24236,6 +24463,8 @@ paths:
       summary: Sign up for parking
       tags:
       - parking
+      x-required-permissions:
+      - parking:manage
   /v1/parking/signup/status:
     get:
       description: Check if your organization has accepted the parking agreement.
@@ -24283,6 +24512,8 @@ paths:
       summary: Get parking signup status
       tags:
       - parking
+      x-required-permissions:
+      - parking:read
   /v1/parking/{parking_reference}/metrics:
     get:
       description: Retrieves metrics for a specific parking entry by ID or domain
@@ -24375,6 +24606,8 @@ paths:
       summary: Get metrics for a parking entry
       tags:
       - parking
+      x-required-permissions:
+      - parking:read
   /v1/reports:
     get:
       operationId: list_reports_v1_reports_get
@@ -24631,6 +24864,8 @@ paths:
       summary: List tags
       tags:
       - tag
+      x-required-permissions:
+      - tags:read
     post:
       description: Create a new tag
       operationId: create_tag_v1_tags_post
@@ -24684,6 +24919,8 @@ paths:
       summary: Create a tag
       tags:
       - tag
+      x-required-permissions:
+      - tags:manage
   /v1/tags/objects:
     post:
       description: Add, remove, or replace tags on multiple objects at once. 'replace'
@@ -24752,6 +24989,8 @@ paths:
       summary: Bulk tag or untag objects
       tags:
       - tag
+      x-required-permissions:
+      - tags:manage
   /v1/tags/{tag_id}:
     delete:
       description: Delete a tag
@@ -24808,6 +25047,8 @@ paths:
       summary: Delete a tag
       tags:
       - tag
+      x-required-permissions:
+      - tags:delete
     get:
       description: Retrieve a single tag by its ID
       operationId: get_tag_v1_tags__tag_id__get
@@ -24867,6 +25108,8 @@ paths:
       summary: Get a tag
       tags:
       - tag
+      x-required-permissions:
+      - tags:read
     patch:
       description: Update a tag's label, description, or color
       operationId: update_tag_v1_tags__tag_id__patch
@@ -24945,6 +25188,8 @@ paths:
       summary: Update a tag
       tags:
       - tag
+      x-required-permissions:
+      - tags:manage
   /v1/tags/{tag_id}/objects:
     post:
       description: Add or remove objects from a tag. Objects are matched by the tag's
@@ -25012,6 +25257,8 @@ paths:
       summary: Tag or untag objects
       tags:
       - tag
+      x-required-permissions:
+      - tags:manage
   /v1/tlds/:
     get:
       description: Retrieves a list of TLD Specifications we have support for
@@ -25155,6 +25402,8 @@ paths:
       summary: Create a user
       tags:
       - user
+      x-required-permissions:
+      - users:manage
   /v1/users/me:
     get:
       description: Get the current user
@@ -25188,6 +25437,8 @@ paths:
       summary: Get current user
       tags:
       - user
+      x-required-permissions:
+      - users:read
   /v1/users/me/password-reset:
     patch:
       operationId: change_password_v1_users_me_password_reset_patch
@@ -25223,6 +25474,8 @@ paths:
       summary: Change Password
       tags:
       - user
+      x-required-permissions:
+      - users:manage
   /v1/users/{user_id}:
     delete:
       description: Delete a user by ID
@@ -25278,6 +25531,8 @@ paths:
       summary: Delete a user
       tags:
       - user
+      x-required-permissions:
+      - users:delete
     get:
       description: Get a user by ID
       operationId: get_user_v1_users__user_id__get
@@ -25322,6 +25577,8 @@ paths:
       summary: Get a user
       tags:
       - user
+      x-required-permissions:
+      - users:read
     patch:
       description: Update a user by ID
       operationId: update_user_v1_users__user_id__patch
@@ -25362,6 +25619,8 @@ paths:
       summary: Update a user
       tags:
       - user
+      x-required-permissions:
+      - users:manage
   /v1/users/{user_id}/permissions:
     get:
       description: Get the permissions for a user
@@ -25397,6 +25656,8 @@ paths:
       summary: Get user permissions
       tags:
       - user
+      x-required-permissions:
+      - users:read
   /v1/users/{user_id}/role:
     get:
       description: Get the role for a user
@@ -25432,6 +25693,8 @@ paths:
       summary: Get user role
       tags:
       - user
+      x-required-permissions:
+      - users:read
     put:
       description: Set the role for a user, replacing any existing role
       operationId: set_user_role_v1_users__user_id__role_put
@@ -25451,7 +25714,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/PublicRoleAssignment'
+              $ref: '#/components/schemas/PublicRoleAssignmentRequest'
         required: true
       responses:
         '200':
@@ -25460,6 +25723,18 @@ paths:
               schema:
                 $ref: '#/components/schemas/PublicRoleAssignment'
           description: Successful Response
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_ONLY_OWNER_CAN_MANAGE_ADMIN_ROLE
+                detail: Additional error context.
+                status: 403
+                title: User Management Error
+                type: only-owner-can-manage-admin-role
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
         '422':
           content:
             application/problem+json:
@@ -25468,7 +25743,6 @@ paths:
           description: Validation Error
       security:
       - OAuth2PasswordBearer: []
-      - APIKeyHeader: []
       summary: Set user role
       tags:
       - user

package/src/schema.d.ts

@@ -2462,6 +2462,11 @@ export interface components {
              */
             min: number;
         };
+        /**
+         * AssignablePublicRole
+         * @enum {string}
+         */
+        AssignablePublicRole: "admin" | "viewer" | "domain_manager" | "dns_manager" | "billing_manager";
         /** AttributeCondition */
         AttributeCondition: {
             /** @description The attribute key to evaluate */
@@ -8673,11 +8678,15 @@ export interface components {
          * PublicRole
          * @enum {string}
          */
-        PublicRole: "admin" | "viewer" | "domain_manager" | "dns_manager" | "billing_manager";
+        PublicRole: "owner" | "admin" | "viewer" | "domain_manager" | "dns_manager" | "billing_manager";
         /** PublicRoleAssignment */
         PublicRoleAssignment: {
             role?: components["schemas"]["PublicRole"] | null;
         };
+        /** PublicRoleAssignmentRequest */
+        PublicRoleAssignmentRequest: {
+            role?: components["schemas"]["AssignablePublicRole"] | null;
+        };
         /**
          * PublicScope
          * @enum {string}
@@ -20649,7 +20658,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["PublicRoleAssignment"];
+                "application/json": components["schemas"]["PublicRoleAssignmentRequest"];
             };
         };
         responses: {
@@ -20662,6 +20671,22 @@ export interface operations {
                     "application/json": components["schemas"]["PublicRoleAssignment"];
                 };
             };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_ONLY_OWNER_CAN_MANAGE_ADMIN_ROLE",
+                     *       "detail": "Additional error context.",
+                     *       "status": 403,
+                     *       "title": "User Management Error",
+                     *       "type": "only-owner-can-manage-admin-role"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
             /** @description Validation Error */
             422: {
                 headers: {