@opusdns/api 0.236.0 → 0.237.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.236.0",
6
+ "version": "0.237.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- 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';
24
+ 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';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -2213,58 +2213,6 @@ export const EXECUTING_ENTITY_VALUES = [
2213
2213
  'system'
2214
2214
  ] as const satisfies [string, ...string[]] | ExecutingEntity[];
2215
2215
 
2216
- /**
2217
- * GrantType. Auto-generated enum for GrantType
2218
- *
2219
- * @remarks
2220
- * This constant provides both object and array forms for the GrantType enum.
2221
- * The object form allows key-value access, while the array form enables iteration and validation.
2222
- *
2223
- * @example
2224
- * ```typescript
2225
- * // Using the object form for key-value access
2226
- * const status = GRANT_TYPE.SUCCESS;
2227
- *
2228
- * // Using the array form for iteration
2229
- * const allStatuses = GRANT_TYPE_VALUES;
2230
- * console.log(`Available statuses: ${allStatuses.join(', ')}`);
2231
- * ```
2232
- *
2233
- * @see {@link GrantType} - The TypeScript type definition
2234
- */
2235
- export const GRANT_TYPE = {
2236
- CLIENT_CREDENTIALS: "client_credentials",
2237
- PASSWORD: "password",
2238
- REFRESH_TOKEN: "refresh_token",
2239
- } as const satisfies Record<string, GrantType>;
2240
-
2241
- /**
2242
- * Array of all GrantType enum values
2243
- *
2244
- * @remarks
2245
- * This constant provides a array containing all valid GrantType enum values.
2246
- * Useful for iteration, validation, and generating dynamic UI components.
2247
- *
2248
- * @example
2249
- * ```typescript
2250
- * // Iterating through all values
2251
- * for (const value of GRANT_TYPE_VALUES) {
2252
- * console.log(`Processing: ${value}`);
2253
- * }
2254
- *
2255
- * // Validation
2256
- * const isValid = GRANT_TYPE_VALUES.includes(someValue);
2257
- * ```
2258
- *
2259
- * @see {@link GrantType} - The TypeScript type definition
2260
- * @see {@link GRANT_TYPE} - The object form of this enum
2261
- */
2262
- export const GRANT_TYPE_VALUES = [
2263
- 'client_credentials',
2264
- 'password',
2265
- 'refresh_token'
2266
- ] as const satisfies [string, ...string[]] | GrantType[];
2267
-
2268
2216
  /**
2269
2217
  * HTTPMethod. HTTP methods and descriptions
2270
2218
 
@@ -34,7 +34,7 @@ import { operations } from '../schema';
34
34
 
35
35
  import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
36
36
 
37
- 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';
37
+ 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';
38
38
 
39
39
  /**
40
40
  * Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
@@ -293,7 +293,21 @@ export type GET_ArchiveRequestHistory_Request_Query = GET_ArchiveRequestHistory_
293
293
  * @see {@link POST_AuthToken_Request_Body} - Request body type
294
294
  */
295
295
  export type POST_AuthToken_Request = {
296
+ requestBody: PublicAuthRequestForm;
296
297
  }
298
+ /**
299
+ * Request body for POST /v1/auth/token
300
+ *
301
+ * @remarks
302
+ * This type defines the request body structure for the POST /v1/auth/token endpoint.
303
+ * It provides type safety for the request body as defined in the OpenAPI specification.
304
+ *
305
+ * @example
306
+ * Use this type to ensure type safety for request body structure.
307
+ *
308
+ * @path /v1/auth/token
309
+ */
310
+ export type POST_AuthToken_Request_Body = POST_AuthToken_Request['requestBody'];
297
311
 
298
312
  /**
299
313
  * Request type for GET Availability endpoint
@@ -331,11 +331,10 @@ export type GET_ArchiveRequestHistory_Response_422 = HTTPValidationError
331
331
  * @path /v1/auth/token
332
332
  *
333
333
  * @see {@link POST_AuthToken_Response_401} - 401 response type
334
- * @see {@link POST_AuthToken_Response_422} - 422 response type
335
334
  *
336
335
 
337
336
  */
338
- export type POST_AuthToken_Response = POST_AuthToken_Response_401 | POST_AuthToken_Response_422;
337
+ export type POST_AuthToken_Response = POST_AuthToken_Response_401;
339
338
 
340
339
  /**
341
340
  * 401 response for POST AuthToken endpoint
@@ -354,23 +353,6 @@ export type POST_AuthToken_Response = POST_AuthToken_Response_401 | POST_AuthTok
354
353
  */
355
354
  export type POST_AuthToken_Response_401 = Problem
356
355
 
357
- /**
358
- * 422 response for POST AuthToken endpoint
359
- *
360
- * @remarks
361
- * This type defines the response structure for the 422 status code
362
- * of the POST AuthToken endpoint.
363
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
364
- *
365
-
366
- *
367
- * @path /v1/auth/token
368
- *
369
- * @see {@link POST_AuthToken_Response} - The main response type definition
370
- * @see {@link HTTPValidationError} - The actual schema type definition
371
- */
372
- export type POST_AuthToken_Response_422 = HTTPValidationError
373
-
374
356
  /**
375
357
  * Response types for GET Availability endpoint
376
358
  *
@@ -3290,22 +3290,6 @@ export type GeoStatsBucket = components['schemas']['GeoStatsBucket'];
3290
3290
  * @see {@link components} - The OpenAPI components schema definition
3291
3291
  */
3292
3292
  export type GetPrices = components['schemas']['GetPricesResponse'];
3293
- /**
3294
- * GrantType
3295
- *
3296
- * @remarks
3297
- * Type alias for the `GrantType` OpenAPI schema.
3298
- * This type represents granttype data structures used in API requests and responses.
3299
- *
3300
- * @example
3301
- * ```typescript
3302
- * const response = await api.getGrantType();
3303
- * const item: GrantType = response.results;
3304
- * ```
3305
- *
3306
- * @see {@link components} - The OpenAPI components schema definition
3307
- */
3308
- export type GrantType = components['schemas']['GrantType'];
3309
3293
  /**
3310
3294
  * HTTPMethod. HTTP methods and descriptions
3311
3295
 
package/src/openapi.yaml CHANGED
@@ -5139,13 +5139,6 @@ components:
5139
5139
  - prices
5140
5140
  title: GetPricesResponse
5141
5141
  type: object
5142
- GrantType:
5143
- enum:
5144
- - client_credentials
5145
- - password
5146
- - refresh_token
5147
- title: GrantType
5148
- type: string
5149
5142
  HTTPMethod:
5150
5143
  description: "HTTP methods and descriptions\n\nMethods from the following RFCs\
5151
5144
  \ are all observed:\n\n * RFC 9110: HTTP Semantics, obsoletes 7231, which\
@@ -9612,16 +9605,20 @@ info:
9612
9605
  \ the `X-Api-Key` header on each request:\n\n```http\nGET /v1/domains HTTP/1.1\n\
9613
9606
  Host: sandbox.opusdns.com\nX-Api-Key: opk_your_full_api_key_here\n```\n\nThis\
9614
9607
  \ is the most direct way to authenticate.\n\n#### Option 2: OAuth token flow\n\
9615
- \nOpusDNS also supports retrieving a bearer token from the token endpoint:\n\n\
9616
- ```http\nPOST /v1/auth/token HTTP/1.1\nHost: sandbox.opusdns.com\nContent-Type:\
9617
- \ application/x-www-form-urlencoded\n\ngrant_type=client_credentials&client_id=organization_...&client_secret=...\n\
9618
- ```\n\nSuccessful responses return a bearer token and expiry:\n\n```json\n{\n\
9619
- \ \"access_token\": \"eyJ...\",\n \"token_type\": \"Bearer\",\n \"expires_in\"\
9620
- : 3600\n}\n```\n\nYou can then use that token on subsequent requests:\n\n```http\n\
9621
- GET /v1/domains HTTP/1.1\nHost: sandbox.opusdns.com\nAuthorization: Bearer eyJ...\n\
9622
- ```\n\nYou can use this method when:\n\n- Your platform prefers standard OAuth-style\
9623
- \ bearer tokens\n- You want short-lived access tokens instead of sending the API\
9624
- \ key on every request\n- Your HTTP tooling already expects `Authorization: Bearer\
9608
+ \nOpusDNS also supports retrieving a bearer token from the token endpoint. The\
9609
+ \ endpoint accepts both `application/x-www-form-urlencoded` (per the OAuth 2.0\
9610
+ \ spec) and `application/json`:\n\n```http\nPOST /v1/auth/token HTTP/1.1\nHost:\
9611
+ \ sandbox.opusdns.com\nContent-Type: application/x-www-form-urlencoded\n\ngrant_type=client_credentials&client_id=organization_...&client_secret=...\n\
9612
+ ```\n\nOr with JSON:\n\n```http\nPOST /v1/auth/token HTTP/1.1\nHost: sandbox.opusdns.com\n\
9613
+ Content-Type: application/json\n\n{\"grant_type\": \"client_credentials\", \"\
9614
+ client_id\": \"organization_...\", \"client_secret\": \"...\"}\n```\n\nSuccessful\
9615
+ \ responses return a bearer token and expiry:\n\n```json\n{\n \"access_token\"\
9616
+ : \"eyJ...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}\n```\n\
9617
+ \nYou can then use that token on subsequent requests:\n\n```http\nGET /v1/domains\
9618
+ \ HTTP/1.1\nHost: sandbox.opusdns.com\nAuthorization: Bearer eyJ...\n```\n\nYou\
9619
+ \ can use this method when:\n\n- Your platform prefers standard OAuth-style bearer\
9620
+ \ tokens\n- You want short-lived access tokens instead of sending the API key\
9621
+ \ on every request\n- Your HTTP tooling already expects `Authorization: Bearer\
9625
9622
  \ ...`\n\n\n\n\n## Resource IDs\n\nThe API uses extensively [Type IDs](https://github.com/jetify-com/typeid):\
9626
9623
  \ type-safe, K-sortable, globally unique identifier inspired by Stripe IDs. They\
9627
9624
  \ can be easily identified with a format like `prefix_01jxe1nzrmf78scaqbkjx0va0f`.\
@@ -9656,7 +9653,7 @@ info:
9656
9653
  \n\n"
9657
9654
  summary: OpusDNS - your gateway to a seamless domain management experience.
9658
9655
  title: OpusDNS API
9659
- version: 2026-04-02-151435
9656
+ version: 2026-04-07-204206
9660
9657
  x-logo:
9661
9658
  altText: OpusDNS API Reference
9662
9659
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -10274,6 +10271,9 @@ paths:
10274
10271
  operationId: issue_organization_token_v1_auth_token_post
10275
10272
  requestBody:
10276
10273
  content:
10274
+ application/json:
10275
+ schema:
10276
+ $ref: '#/components/schemas/PublicAuthRequestForm'
10277
10277
  application/x-www-form-urlencoded:
10278
10278
  schema:
10279
10279
  $ref: '#/components/schemas/PublicAuthRequestForm'
@@ -10299,12 +10299,6 @@ paths:
10299
10299
  schema:
10300
10300
  $ref: '#/components/schemas/Problem'
10301
10301
  description: Unauthorized
10302
- '422':
10303
- content:
10304
- application/problem+json:
10305
- schema:
10306
- $ref: '#/components/schemas/HTTPValidationError'
10307
- description: Validation Error
10308
10302
  security:
10309
10303
  - APIKeyHeader: []
10310
10304
  - OAuth2PasswordBearer: []
package/src/schema.d.ts CHANGED
@@ -5634,11 +5634,6 @@ export interface components {
5634
5634
  */
5635
5635
  prices: components["schemas"]["PriceInfo"][];
5636
5636
  };
5637
- /**
5638
- * GrantType
5639
- * @enum {string}
5640
- */
5641
- GrantType: "client_credentials" | "password" | "refresh_token";
5642
5637
  /**
5643
5638
  * HTTPMethod
5644
5639
  * @description HTTP methods and descriptions
@@ -8826,6 +8821,7 @@ export interface operations {
8826
8821
  };
8827
8822
  requestBody?: {
8828
8823
  content: {
8824
+ "application/json": components["schemas"]["PublicAuthRequestForm"];
8829
8825
  "application/x-www-form-urlencoded": components["schemas"]["PublicAuthRequestForm"];
8830
8826
  };
8831
8827
  };
@@ -8855,15 +8851,6 @@ export interface operations {
8855
8851
  "application/problem+json": components["schemas"]["Problem"];
8856
8852
  };
8857
8853
  };
8858
- /** @description Validation Error */
8859
- 422: {
8860
- headers: {
8861
- [name: string]: unknown;
8862
- };
8863
- content: {
8864
- "application/problem+json": components["schemas"]["HTTPValidationError"];
8865
- };
8866
- };
8867
8854
  };
8868
8855
  };
8869
8856
  bulk_availability_v1_availability_get: {