@opusdns/api 0.236.0 → 0.238.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 +1 -1
- package/src/helpers/constants.ts +1 -53
- package/src/helpers/requests.d.ts +15 -1
- package/src/helpers/responses.d.ts +4 -82
- package/src/helpers/schemas.d.ts +0 -16
- package/src/openapi.yaml +20 -61
- package/src/schema.d.ts +2 -62
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -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,
|
|
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
|
|
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
|
*
|
|
@@ -392,11 +374,10 @@ Specify one or more domains to check for availability.
|
|
|
392
374
|
* @see {@link GET_Availability_Response_200} - 200 response type
|
|
393
375
|
* @see {@link GET_Availability_Response_401} - 401 response type
|
|
394
376
|
* @see {@link GET_Availability_Response_422} - 422 response type
|
|
395
|
-
* @see {@link GET_Availability_Response_500} - 500 response type
|
|
396
377
|
*
|
|
397
378
|
|
|
398
379
|
*/
|
|
399
|
-
export type GET_Availability_Response = GET_Availability_Response_200 | GET_Availability_Response_401 | GET_Availability_Response_422
|
|
380
|
+
export type GET_Availability_Response = GET_Availability_Response_200 | GET_Availability_Response_401 | GET_Availability_Response_422;
|
|
400
381
|
|
|
401
382
|
/**
|
|
402
383
|
* 200 response for GET Availability endpoint
|
|
@@ -458,26 +439,6 @@ Specify one or more domains to check for availability.
|
|
|
458
439
|
*/
|
|
459
440
|
export type GET_Availability_Response_422 = HTTPValidationError
|
|
460
441
|
|
|
461
|
-
/**
|
|
462
|
-
* 500 response for GET Availability endpoint
|
|
463
|
-
*
|
|
464
|
-
* @remarks
|
|
465
|
-
* This type defines the response structure for the 500 status code
|
|
466
|
-
* of the GET Availability endpoint.
|
|
467
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
468
|
-
*
|
|
469
|
-
|
|
470
|
-
*
|
|
471
|
-
* @path /v1/availability
|
|
472
|
-
* @param domains (query) -
|
|
473
|
-
Specify one or more domains to check for availability.
|
|
474
|
-
|
|
475
|
-
*
|
|
476
|
-
* @see {@link GET_Availability_Response} - The main response type definition
|
|
477
|
-
* @see {@link Problem} - The actual schema type definition
|
|
478
|
-
*/
|
|
479
|
-
export type GET_Availability_Response_500 = Problem
|
|
480
|
-
|
|
481
442
|
/**
|
|
482
443
|
* Response types for GET AvailabilityStream endpoint
|
|
483
444
|
*
|
|
@@ -498,11 +459,10 @@ Specify one or more domains to check for availability.
|
|
|
498
459
|
*
|
|
499
460
|
* @see {@link GET_AvailabilityStream_Response_401} - 401 response type
|
|
500
461
|
* @see {@link GET_AvailabilityStream_Response_422} - 422 response type
|
|
501
|
-
* @see {@link GET_AvailabilityStream_Response_500} - 500 response type
|
|
502
462
|
*
|
|
503
463
|
|
|
504
464
|
*/
|
|
505
|
-
export type GET_AvailabilityStream_Response = GET_AvailabilityStream_Response_401 | GET_AvailabilityStream_Response_422
|
|
465
|
+
export type GET_AvailabilityStream_Response = GET_AvailabilityStream_Response_401 | GET_AvailabilityStream_Response_422;
|
|
506
466
|
|
|
507
467
|
/**
|
|
508
468
|
* 401 response for GET AvailabilityStream endpoint
|
|
@@ -544,26 +504,6 @@ Specify one or more domains to check for availability.
|
|
|
544
504
|
*/
|
|
545
505
|
export type GET_AvailabilityStream_Response_422 = HTTPValidationError
|
|
546
506
|
|
|
547
|
-
/**
|
|
548
|
-
* 500 response for GET AvailabilityStream endpoint
|
|
549
|
-
*
|
|
550
|
-
* @remarks
|
|
551
|
-
* This type defines the response structure for the 500 status code
|
|
552
|
-
* of the GET AvailabilityStream endpoint.
|
|
553
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
554
|
-
*
|
|
555
|
-
|
|
556
|
-
*
|
|
557
|
-
* @path /v1/availability/stream
|
|
558
|
-
* @param domains (query) -
|
|
559
|
-
Specify one or more domains to check for availability.
|
|
560
|
-
|
|
561
|
-
*
|
|
562
|
-
* @see {@link GET_AvailabilityStream_Response} - The main response type definition
|
|
563
|
-
* @see {@link Problem} - The actual schema type definition
|
|
564
|
-
*/
|
|
565
|
-
export type GET_AvailabilityStream_Response_500 = Problem
|
|
566
|
-
|
|
567
507
|
/**
|
|
568
508
|
* Response types for POST AvailabilityStream endpoint
|
|
569
509
|
*
|
|
@@ -581,11 +521,10 @@ export type GET_AvailabilityStream_Response_500 = Problem
|
|
|
581
521
|
*
|
|
582
522
|
* @see {@link POST_AvailabilityStream_Response_401} - 401 response type
|
|
583
523
|
* @see {@link POST_AvailabilityStream_Response_422} - 422 response type
|
|
584
|
-
* @see {@link POST_AvailabilityStream_Response_500} - 500 response type
|
|
585
524
|
*
|
|
586
525
|
|
|
587
526
|
*/
|
|
588
|
-
export type POST_AvailabilityStream_Response = POST_AvailabilityStream_Response_401 | POST_AvailabilityStream_Response_422
|
|
527
|
+
export type POST_AvailabilityStream_Response = POST_AvailabilityStream_Response_401 | POST_AvailabilityStream_Response_422;
|
|
589
528
|
|
|
590
529
|
/**
|
|
591
530
|
* 401 response for POST AvailabilityStream endpoint
|
|
@@ -621,23 +560,6 @@ export type POST_AvailabilityStream_Response_401 = Problem
|
|
|
621
560
|
*/
|
|
622
561
|
export type POST_AvailabilityStream_Response_422 = HTTPValidationError
|
|
623
562
|
|
|
624
|
-
/**
|
|
625
|
-
* 500 response for POST AvailabilityStream endpoint
|
|
626
|
-
*
|
|
627
|
-
* @remarks
|
|
628
|
-
* This type defines the response structure for the 500 status code
|
|
629
|
-
* of the POST AvailabilityStream endpoint.
|
|
630
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
631
|
-
*
|
|
632
|
-
|
|
633
|
-
*
|
|
634
|
-
* @path /v1/availability/stream
|
|
635
|
-
*
|
|
636
|
-
* @see {@link POST_AvailabilityStream_Response} - The main response type definition
|
|
637
|
-
* @see {@link Problem} - The actual schema type definition
|
|
638
|
-
*/
|
|
639
|
-
export type POST_AvailabilityStream_Response_500 = Problem
|
|
640
|
-
|
|
641
563
|
/**
|
|
642
564
|
* Response types for GET Contacts endpoint
|
|
643
565
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -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
|
|
9616
|
-
|
|
9617
|
-
\ application/
|
|
9618
|
-
|
|
9619
|
-
\
|
|
9620
|
-
:
|
|
9621
|
-
|
|
9622
|
-
|
|
9623
|
-
\
|
|
9624
|
-
\
|
|
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-
|
|
9656
|
+
version: 2026-04-08-115618
|
|
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: []
|
|
@@ -10338,7 +10332,7 @@ paths:
|
|
|
10338
10332
|
'
|
|
10339
10333
|
items:
|
|
10340
10334
|
type: string
|
|
10341
|
-
maxItems:
|
|
10335
|
+
maxItems: 50
|
|
10342
10336
|
title: Domains
|
|
10343
10337
|
type: array
|
|
10344
10338
|
responses:
|
|
@@ -10366,18 +10360,6 @@ paths:
|
|
|
10366
10360
|
schema:
|
|
10367
10361
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
10368
10362
|
description: Validation Error
|
|
10369
|
-
'500':
|
|
10370
|
-
content:
|
|
10371
|
-
application/problem+json:
|
|
10372
|
-
example:
|
|
10373
|
-
code: ERROR_AVAILABILITY_PROVIDER
|
|
10374
|
-
detail: Additional error context.
|
|
10375
|
-
status: 500
|
|
10376
|
-
title: Availability Error
|
|
10377
|
-
type: availability-internal
|
|
10378
|
-
schema:
|
|
10379
|
-
$ref: '#/components/schemas/Problem'
|
|
10380
|
-
description: Internal Server Error
|
|
10381
10363
|
security:
|
|
10382
10364
|
- OAuth2PasswordBearer: []
|
|
10383
10365
|
- APIKeyHeader: []
|
|
@@ -10386,6 +10368,7 @@ paths:
|
|
|
10386
10368
|
- availability
|
|
10387
10369
|
/v1/availability/stream:
|
|
10388
10370
|
get:
|
|
10371
|
+
deprecated: true
|
|
10389
10372
|
description: Stream domain availability results using Server-Sent Events (SSE)
|
|
10390
10373
|
until the `done` event is received.
|
|
10391
10374
|
operationId: stream_availability_v1_availability_stream_get
|
|
@@ -10449,18 +10432,6 @@ paths:
|
|
|
10449
10432
|
schema:
|
|
10450
10433
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
10451
10434
|
description: Validation Error
|
|
10452
|
-
'500':
|
|
10453
|
-
content:
|
|
10454
|
-
application/problem+json:
|
|
10455
|
-
example:
|
|
10456
|
-
code: ERROR_AVAILABILITY_PROVIDER
|
|
10457
|
-
detail: Additional error context.
|
|
10458
|
-
status: 500
|
|
10459
|
-
title: Availability Error
|
|
10460
|
-
type: availability-internal
|
|
10461
|
-
schema:
|
|
10462
|
-
$ref: '#/components/schemas/Problem'
|
|
10463
|
-
description: Internal Server Error
|
|
10464
10435
|
security:
|
|
10465
10436
|
- OAuth2PasswordBearer: []
|
|
10466
10437
|
- APIKeyHeader: []
|
|
@@ -10511,18 +10482,6 @@ paths:
|
|
|
10511
10482
|
schema:
|
|
10512
10483
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
10513
10484
|
description: Validation Error
|
|
10514
|
-
'500':
|
|
10515
|
-
content:
|
|
10516
|
-
application/problem+json:
|
|
10517
|
-
example:
|
|
10518
|
-
code: ERROR_AVAILABILITY_PROVIDER
|
|
10519
|
-
detail: Additional error context.
|
|
10520
|
-
status: 500
|
|
10521
|
-
title: Availability Error
|
|
10522
|
-
type: availability-internal
|
|
10523
|
-
schema:
|
|
10524
|
-
$ref: '#/components/schemas/Problem'
|
|
10525
|
-
description: Internal Server Error
|
|
10526
10485
|
security:
|
|
10527
10486
|
- OAuth2PasswordBearer: []
|
|
10528
10487
|
- APIKeyHeader: []
|
package/src/schema.d.ts
CHANGED
|
@@ -146,6 +146,7 @@ export interface paths {
|
|
|
146
146
|
};
|
|
147
147
|
/**
|
|
148
148
|
* Stream domain availability results
|
|
149
|
+
* @deprecated
|
|
149
150
|
* @description Stream domain availability results using Server-Sent Events (SSE) until the `done` event is received.
|
|
150
151
|
*/
|
|
151
152
|
get: operations["stream_availability_v1_availability_stream_get"];
|
|
@@ -5634,11 +5635,6 @@ export interface components {
|
|
|
5634
5635
|
*/
|
|
5635
5636
|
prices: components["schemas"]["PriceInfo"][];
|
|
5636
5637
|
};
|
|
5637
|
-
/**
|
|
5638
|
-
* GrantType
|
|
5639
|
-
* @enum {string}
|
|
5640
|
-
*/
|
|
5641
|
-
GrantType: "client_credentials" | "password" | "refresh_token";
|
|
5642
5638
|
/**
|
|
5643
5639
|
* HTTPMethod
|
|
5644
5640
|
* @description HTTP methods and descriptions
|
|
@@ -8826,6 +8822,7 @@ export interface operations {
|
|
|
8826
8822
|
};
|
|
8827
8823
|
requestBody?: {
|
|
8828
8824
|
content: {
|
|
8825
|
+
"application/json": components["schemas"]["PublicAuthRequestForm"];
|
|
8829
8826
|
"application/x-www-form-urlencoded": components["schemas"]["PublicAuthRequestForm"];
|
|
8830
8827
|
};
|
|
8831
8828
|
};
|
|
@@ -8855,15 +8852,6 @@ export interface operations {
|
|
|
8855
8852
|
"application/problem+json": components["schemas"]["Problem"];
|
|
8856
8853
|
};
|
|
8857
8854
|
};
|
|
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
8855
|
};
|
|
8868
8856
|
};
|
|
8869
8857
|
bulk_availability_v1_availability_get: {
|
|
@@ -8914,22 +8902,6 @@ export interface operations {
|
|
|
8914
8902
|
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8915
8903
|
};
|
|
8916
8904
|
};
|
|
8917
|
-
/** @description Internal Server Error */
|
|
8918
|
-
500: {
|
|
8919
|
-
headers: {
|
|
8920
|
-
[name: string]: unknown;
|
|
8921
|
-
};
|
|
8922
|
-
content: {
|
|
8923
|
-
/** @example {
|
|
8924
|
-
* "code": "ERROR_AVAILABILITY_PROVIDER",
|
|
8925
|
-
* "detail": "Additional error context.",
|
|
8926
|
-
* "status": 500,
|
|
8927
|
-
* "title": "Availability Error",
|
|
8928
|
-
* "type": "availability-internal"
|
|
8929
|
-
* } */
|
|
8930
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
8931
|
-
};
|
|
8932
|
-
};
|
|
8933
8905
|
};
|
|
8934
8906
|
};
|
|
8935
8907
|
stream_availability_v1_availability_stream_get: {
|
|
@@ -8980,22 +8952,6 @@ export interface operations {
|
|
|
8980
8952
|
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8981
8953
|
};
|
|
8982
8954
|
};
|
|
8983
|
-
/** @description Internal Server Error */
|
|
8984
|
-
500: {
|
|
8985
|
-
headers: {
|
|
8986
|
-
[name: string]: unknown;
|
|
8987
|
-
};
|
|
8988
|
-
content: {
|
|
8989
|
-
/** @example {
|
|
8990
|
-
* "code": "ERROR_AVAILABILITY_PROVIDER",
|
|
8991
|
-
* "detail": "Additional error context.",
|
|
8992
|
-
* "status": 500,
|
|
8993
|
-
* "title": "Availability Error",
|
|
8994
|
-
* "type": "availability-internal"
|
|
8995
|
-
* } */
|
|
8996
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
8997
|
-
};
|
|
8998
|
-
};
|
|
8999
8955
|
};
|
|
9000
8956
|
};
|
|
9001
8957
|
stream_availability_post_v1_availability_stream_post: {
|
|
@@ -9045,22 +9001,6 @@ export interface operations {
|
|
|
9045
9001
|
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
9046
9002
|
};
|
|
9047
9003
|
};
|
|
9048
|
-
/** @description Internal Server Error */
|
|
9049
|
-
500: {
|
|
9050
|
-
headers: {
|
|
9051
|
-
[name: string]: unknown;
|
|
9052
|
-
};
|
|
9053
|
-
content: {
|
|
9054
|
-
/** @example {
|
|
9055
|
-
* "code": "ERROR_AVAILABILITY_PROVIDER",
|
|
9056
|
-
* "detail": "Additional error context.",
|
|
9057
|
-
* "status": 500,
|
|
9058
|
-
* "title": "Availability Error",
|
|
9059
|
-
* "type": "availability-internal"
|
|
9060
|
-
* } */
|
|
9061
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
9062
|
-
};
|
|
9063
|
-
};
|
|
9064
9004
|
};
|
|
9065
9005
|
};
|
|
9066
9006
|
get_contacts_v1_contacts_get: {
|