@opusdns/api 0.235.0 → 0.237.0

package/package.json

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

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -2213,58 +2213,6 @@ export const EXECUTING_ENTITY_VALUES = [
   'system'
 ] as const satisfies [string, ...string[]] | ExecutingEntity[];
 
-/**
- * GrantType. Auto-generated enum for GrantType
- *
- * @remarks
- * This constant provides both object and array forms for the GrantType enum.
- * The object form allows key-value access, while the array form enables iteration and validation.
- *
- * @example
- * ```typescript
- * // Using the object form for key-value access
- * const status = GRANT_TYPE.SUCCESS;
- * 
- * // Using the array form for iteration
- * const allStatuses = GRANT_TYPE_VALUES;
- * console.log(`Available statuses: ${allStatuses.join(', ')}`);
- * ```
- *
- * @see {@link GrantType} - The TypeScript type definition
- */
-export const GRANT_TYPE = {
-  CLIENT_CREDENTIALS: "client_credentials",
-  PASSWORD: "password",
-  REFRESH_TOKEN: "refresh_token",
-} as const satisfies Record<string, GrantType>;
-
-/**
- * Array of all GrantType enum values
- *
- * @remarks
- * This constant provides a array containing all valid GrantType enum values.
- * Useful for iteration, validation, and generating dynamic UI components.
- *
- * @example
- * ```typescript
- * // Iterating through all values
- * for (const value of GRANT_TYPE_VALUES) {
- *   console.log(`Processing: ${value}`);
- * }
- * 
- * // Validation
- * const isValid = GRANT_TYPE_VALUES.includes(someValue);
- * ```
- *
- * @see {@link GrantType} - The TypeScript type definition
- * @see {@link GRANT_TYPE} - The object form of this enum
- */
-export const GRANT_TYPE_VALUES = [
-  'client_credentials',
-  'password',
-  'refresh_token'
-] as const satisfies [string, ...string[]] | GrantType[];
-
 /**
  * HTTPMethod. HTTP methods and descriptions
 

package/src/helpers/requests.d.ts

@@ -34,7 +34,7 @@ import { operations } from '../schema';
 
 import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-import { DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
+import { PublicAuthRequestForm, DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
@@ -293,7 +293,21 @@ export type GET_ArchiveRequestHistory_Request_Query = GET_ArchiveRequestHistory_
  * @see {@link POST_AuthToken_Request_Body} - Request body type
  */
 export type POST_AuthToken_Request = {
+  requestBody: PublicAuthRequestForm;
 }
+/**
+ * Request body for POST /v1/auth/token
+ *
+ * @remarks
+ * This type defines the request body structure for the POST /v1/auth/token endpoint.
+ * It provides type safety for the request body as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for request body structure.
+ *
+ * @path /v1/auth/token
+ */
+export type POST_AuthToken_Request_Body = POST_AuthToken_Request['requestBody'];
 
 /**
  * Request type for GET Availability endpoint

package/src/helpers/responses.d.ts

@@ -331,11 +331,10 @@ export type GET_ArchiveRequestHistory_Response_422 = HTTPValidationError
  * @path /v1/auth/token
  *
  * @see {@link POST_AuthToken_Response_401} - 401 response type
- * @see {@link POST_AuthToken_Response_422} - 422 response type
  *
 
  */
-export type POST_AuthToken_Response = POST_AuthToken_Response_401 | POST_AuthToken_Response_422;
+export type POST_AuthToken_Response = POST_AuthToken_Response_401;
 
 /**
  * 401 response for POST AuthToken endpoint
@@ -354,23 +353,6 @@ export type POST_AuthToken_Response = POST_AuthToken_Response_401 | POST_AuthTok
  */
 export type POST_AuthToken_Response_401 = Problem
 
-/**
- * 422 response for POST AuthToken endpoint
- *
- * @remarks
- * This type defines the response structure for the 422 status code
- * of the POST AuthToken endpoint.
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
- *
-
- *
- * @path /v1/auth/token
- *
- * @see {@link POST_AuthToken_Response} - The main response type definition
- * @see {@link HTTPValidationError} - The actual schema type definition
- */
-export type POST_AuthToken_Response_422 = HTTPValidationError
-
 /**
  * Response types for GET Availability endpoint
  *

package/src/helpers/schemas.d.ts

@@ -3290,22 +3290,6 @@ export type GeoStatsBucket = components['schemas']['GeoStatsBucket'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type GetPrices = components['schemas']['GetPricesResponse'];
-/**
- * GrantType
- *
- * @remarks
- * Type alias for the `GrantType` OpenAPI schema.
- * This type represents granttype data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getGrantType();
- * const item: GrantType = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type GrantType = components['schemas']['GrantType'];
 /**
  * HTTPMethod. HTTP methods and descriptions
 

package/src/openapi.yaml

@@ -5139,13 +5139,6 @@ components:
       - prices
       title: GetPricesResponse
       type: object
-    GrantType:
-      enum:
-      - client_credentials
-      - password
-      - refresh_token
-      title: GrantType
-      type: string
     HTTPMethod:
       description: "HTTP methods and descriptions\n\nMethods from the following RFCs\
         \ are all observed:\n\n    * RFC 9110: HTTP Semantics, obsoletes 7231, which\
@@ -9612,16 +9605,20 @@ info:
     \ the `X-Api-Key` header on each request:\n\n```http\nGET /v1/domains HTTP/1.1\n\
     Host: sandbox.opusdns.com\nX-Api-Key: opk_your_full_api_key_here\n```\n\nThis\
     \ is the most direct way to authenticate.\n\n#### Option 2: OAuth token flow\n\
-    \nOpusDNS also supports retrieving a bearer token from the token endpoint:\n\n\
-    ```http\nPOST /v1/auth/token HTTP/1.1\nHost: sandbox.opusdns.com\nContent-Type:\
-    \ application/x-www-form-urlencoded\n\ngrant_type=client_credentials&client_id=organization_...&client_secret=...\n\
-    ```\n\nSuccessful responses return a bearer token and expiry:\n\n```json\n{\n\
-    \  \"access_token\": \"eyJ...\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\"\
-    : 3600\n}\n```\n\nYou can then use that token on subsequent requests:\n\n```http\n\
-    GET /v1/domains HTTP/1.1\nHost: sandbox.opusdns.com\nAuthorization: Bearer eyJ...\n\
-    ```\n\nYou can use this method when:\n\n- Your platform prefers standard OAuth-style\
-    \ bearer tokens\n- You want short-lived access tokens instead of sending the API\
-    \ key on every request\n- Your HTTP tooling already expects `Authorization: Bearer\
+    \nOpusDNS also supports retrieving a bearer token from the token endpoint. The\
+    \ endpoint accepts both `application/x-www-form-urlencoded` (per the OAuth 2.0\
+    \ spec) and `application/json`:\n\n```http\nPOST /v1/auth/token HTTP/1.1\nHost:\
+    \ sandbox.opusdns.com\nContent-Type: application/x-www-form-urlencoded\n\ngrant_type=client_credentials&client_id=organization_...&client_secret=...\n\
+    ```\n\nOr with JSON:\n\n```http\nPOST /v1/auth/token HTTP/1.1\nHost: sandbox.opusdns.com\n\
+    Content-Type: application/json\n\n{\"grant_type\": \"client_credentials\", \"\
+    client_id\": \"organization_...\", \"client_secret\": \"...\"}\n```\n\nSuccessful\
+    \ responses return a bearer token and expiry:\n\n```json\n{\n  \"access_token\"\
+    : \"eyJ...\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 3600\n}\n```\n\
+    \nYou can then use that token on subsequent requests:\n\n```http\nGET /v1/domains\
+    \ HTTP/1.1\nHost: sandbox.opusdns.com\nAuthorization: Bearer eyJ...\n```\n\nYou\
+    \ can use this method when:\n\n- Your platform prefers standard OAuth-style bearer\
+    \ tokens\n- You want short-lived access tokens instead of sending the API key\
+    \ on every request\n- Your HTTP tooling already expects `Authorization: Bearer\
     \ ...`\n\n\n\n\n## Resource IDs\n\nThe API uses extensively [Type IDs](https://github.com/jetify-com/typeid):\
     \ type-safe, K-sortable, globally unique identifier inspired by Stripe IDs. They\
     \ can be easily identified with a format like `prefix_01jxe1nzrmf78scaqbkjx0va0f`.\
@@ -9656,7 +9653,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-02-142331
+  version: 2026-04-07-204206
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -10274,6 +10271,9 @@ paths:
       operationId: issue_organization_token_v1_auth_token_post
       requestBody:
         content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PublicAuthRequestForm'
           application/x-www-form-urlencoded:
             schema:
               $ref: '#/components/schemas/PublicAuthRequestForm'
@@ -10299,12 +10299,6 @@ paths:
               schema:
                 $ref: '#/components/schemas/Problem'
           description: Unauthorized
-        '422':
-          content:
-            application/problem+json:
-              schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
       security:
       - APIKeyHeader: []
       - OAuth2PasswordBearer: []
@@ -21333,19 +21327,31 @@ tags:
     \ the whole system.\n"
   name: user
   x-displayName: Users
-- description: "Endpoints for generating and downloading inventory reports.\n\nReports\
-    \ provide exportable snapshots of your domain and DNS data. Reports are generated\
+- description: "Endpoints for generating and downloading reports.\n\nReports provide\
+    \ exportable snapshots of your domain, DNS, and billing data. Reports are generated\
     \ asynchronously and can be downloaded as ZIP files once complete.\n\n### Report\
     \ Types\n\n| Type | Description |\n|------|-------------|\n| `domain_inventory`\
     \ | Full inventory of all domains in the organization |\n| `dns_zone_summary`\
     \ | Summary of all DNS zones and their configuration |\n| `dns_zone_records` |\
-    \ Detailed export of all DNS records across zones |\n\n### Report Lifecycle\n\n\
-    A report transitions through the following statuses:\n\n1. **pending** \u2014\
-    \ Report has been queued for generation\n2. **generating** \u2014 Report is being\
-    \ built\n3. **completed** \u2014 Report is ready for download\n4. **failed** \u2014\
-    \ Generation failed\n\n### Usage Pattern\n\n1. **Request a report** \u2014 `POST\
-    \ /v1/reports` with the desired `report_type`\n2. **Poll for completion** \u2014\
-    \ `GET /v1/reports/{report_id}` until `status` is `completed`\n3. **Download**\
+    \ Detailed export of all DNS records across zones |\n| `billing_transactions`\
+    \ | Billing transactions for the current month to date |\n| `billing_transactions_monthly`\
+    \ | Billing transactions for the previous calendar month |\n\n### Billing Transaction\
+    \ Reports\n\nBilling transaction reports export all completed transactions as\
+    \ a CSV with the following columns: `product_reference`, `action`, `period`, `product_type`,\
+    \ `amount`, `currency`, `completed_on`.\n\nThere are two billing report types:\n\
+    \n- **`billing_transactions`** \u2014 On-demand report covering the current month\
+    \ to date (1st of the month through the time of the request). Request this via\
+    \ the API like any other report type.\n- **`billing_transactions_monthly`** \u2014\
+    \ Automatically generated on the 1st of each month at 5 AM UTC, covering the full\
+    \ previous calendar month. These are scheduled reports and do not need to be manually\
+    \ requested.\n\nBoth types maintain their own retention of 30 reports each, so\
+    \ requesting on-demand reports will not displace the monthly archive.\n\n### Report\
+    \ Lifecycle\n\nA report transitions through the following statuses:\n\n1. **pending**\
+    \ \u2014 Report has been queued for generation\n2. **generating** \u2014 Report\
+    \ is being built\n3. **completed** \u2014 Report is ready for download\n4. **failed**\
+    \ \u2014 Generation failed\n\n### Usage Pattern\n\n1. **Request a report** \u2014\
+    \ `POST /v1/reports` with the desired `report_type`\n2. **Poll for completion**\
+    \ \u2014 `GET /v1/reports/{report_id}` until `status` is `completed`\n3. **Download**\
     \ \u2014 `GET /v1/reports/{report_id}/download` returns the report as a streamed\
     \ ZIP file\n\n### Downloading Reports\n\n`GET /v1/reports/{report_id}/download`\
     \ streams the report file directly to the client. The report **must** have status\

package/src/schema.d.ts

@@ -5634,11 +5634,6 @@ export interface components {
              */
             prices: components["schemas"]["PriceInfo"][];
         };
-        /**
-         * GrantType
-         * @enum {string}
-         */
-        GrantType: "client_credentials" | "password" | "refresh_token";
         /**
          * HTTPMethod
          * @description HTTP methods and descriptions
@@ -8826,6 +8821,7 @@ export interface operations {
         };
         requestBody?: {
             content: {
+                "application/json": components["schemas"]["PublicAuthRequestForm"];
                 "application/x-www-form-urlencoded": components["schemas"]["PublicAuthRequestForm"];
             };
         };
@@ -8855,15 +8851,6 @@ export interface operations {
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/problem+json": components["schemas"]["HTTPValidationError"];
-                };
-            };
         };
     };
     bulk_availability_v1_availability_get: {