@opusdns/api 0.289.0 → 0.291.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 +257 -1
- package/src/helpers/keys.ts +2206 -291
- package/src/helpers/requests.d.ts +45 -5
- package/src/helpers/responses.d.ts +123 -10
- package/src/helpers/schemas-arrays.d.ts +141 -1
- package/src/helpers/schemas.d.ts +368 -16
- package/src/openapi.yaml +644 -132
- package/src/schema.d.ts +458 -88
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { ConversationCreateRequest, ConversationPatchRequest, ContextCreateRequest, MessageCreateRequest, MemoryFactCreateRequest, MemoryFactPatchRequest, 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, TagCreate, BulkObjectTagChanges, TagUpdate, ObjectTagChanges, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { ConversationCreateRequest, ConversationPatchRequest, ContextCreateRequest, MessageCreateRequest, MemoryFactCreateRequest, MemoryFactPatchRequest, PublicAuthRequestForm, DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, ClaimsNoticesRequest, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, JobBatchRequest, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, TagCreate, BulkObjectTagChanges, TagUpdate, ObjectTagChanges, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AiConciergeContextsContextId endpoint
|
|
@@ -3371,7 +3371,10 @@ export type GET_Domains_Request_Query = GET_Domains_Request['parameters']['query
|
|
|
3371
3371
|
* Request type for POST Domains endpoint
|
|
3372
3372
|
*
|
|
3373
3373
|
* Create a domain
|
|
3374
|
-
* Registers a new domain
|
|
3374
|
+
* Registers a new domain.
|
|
3375
|
+
|
|
3376
|
+
- **Premium domains** - when the registry classifies the domain as premium, an `expected_price` must be supplied to confirm the non-standard price returned by the availability check. See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
|
|
3377
|
+
- **Trademark claims (TMCH)** - when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_notice_acceptance_hash` must be supplied to acknowledge the corresponding claims notice. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
|
|
3375
3378
|
*
|
|
3376
3379
|
* @remarks
|
|
3377
3380
|
* This type defines the complete request structure for the POST Domains endpoint.
|
|
@@ -3411,9 +3414,9 @@ export type POST_Domains_Request_Body = POST_Domains_Request['requestBody'];
|
|
|
3411
3414
|
* Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
|
|
3412
3415
|
|
|
3413
3416
|
For each domain the response includes:
|
|
3414
|
-
- **Availability**
|
|
3415
|
-
- **
|
|
3416
|
-
- **
|
|
3417
|
+
- **Availability** - whether the domain can be registered, and the registry's reason if not.
|
|
3418
|
+
- **Premium status and pricing** - whether the domain is classified as premium by the registry, and if so, the price per action (create / renew / transfer / restore). See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
|
|
3419
|
+
- **Trademark claims (TMCH)** - when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_key` is returned. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
|
|
3417
3420
|
|
|
3418
3421
|
Domains are queried in parallel, grouped by registry connection. Availability and metadata reflect the registry's state at the moment of the call and are not cached.
|
|
3419
3422
|
*
|
|
@@ -3464,6 +3467,43 @@ include a mix of TLDs.
|
|
|
3464
3467
|
*/
|
|
3465
3468
|
export type GET_DomainsCheck_Request_Query = GET_DomainsCheck_Request['parameters']['query'];
|
|
3466
3469
|
|
|
3470
|
+
/**
|
|
3471
|
+
* Request type for POST DomainsClaimsNotices endpoint
|
|
3472
|
+
*
|
|
3473
|
+
* Retrieve claims notices from claim keys
|
|
3474
|
+
* Retrieves the trademark claims notice for a `claims_key` returned during a domain availability check. The response contains a `claims_notice_acceptance_hash` to acknowledge the notice when registering the domain, a ready-to-display `rendered_html`, and the structured fields needed to render a custom notice. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
|
|
3475
|
+
*
|
|
3476
|
+
* @remarks
|
|
3477
|
+
* This type defines the complete request structure for the POST DomainsClaimsNotices endpoint.
|
|
3478
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3479
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3480
|
+
*
|
|
3481
|
+
* @example
|
|
3482
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3483
|
+
*
|
|
3484
|
+
* @path /v1/domains/claims-notices
|
|
3485
|
+
*
|
|
3486
|
+
* @see {@link POST_DomainsClaimsNotices_Request_Query} - Query parameters type
|
|
3487
|
+
* @see {@link POST_DomainsClaimsNotices_Request_Path} - Path parameters type
|
|
3488
|
+
* @see {@link POST_DomainsClaimsNotices_Request_Body} - Request body type
|
|
3489
|
+
*/
|
|
3490
|
+
export type POST_DomainsClaimsNotices_Request = {
|
|
3491
|
+
requestBody: ClaimsNoticesRequest;
|
|
3492
|
+
}
|
|
3493
|
+
/**
|
|
3494
|
+
* Request body for POST /v1/domains/claims-notices
|
|
3495
|
+
*
|
|
3496
|
+
* @remarks
|
|
3497
|
+
* This type defines the request body structure for the POST /v1/domains/claims-notices endpoint.
|
|
3498
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
3499
|
+
*
|
|
3500
|
+
* @example
|
|
3501
|
+
* Use this type to ensure type safety for request body structure.
|
|
3502
|
+
*
|
|
3503
|
+
* @path /v1/domains/claims-notices
|
|
3504
|
+
*/
|
|
3505
|
+
export type POST_DomainsClaimsNotices_Request_Body = POST_DomainsClaimsNotices_Request['requestBody'];
|
|
3506
|
+
|
|
3467
3507
|
/**
|
|
3468
3508
|
* Request type for DELETE DomainsDomainReference endpoint
|
|
3469
3509
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event,
|
|
37
|
+
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, ClaimsNotices, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventResponse, Job, Pagination_JobBatchMetadata, CreateJobBatch, JobBatchStatus, Pagination_Job, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, PublicReportListRes, PublicReportRes, Pagination_Tag, Tag, ObjectTagChanges2, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AiConciergeContextsByContextId endpoint
|
|
@@ -6741,7 +6741,10 @@ export type GET_Domains_Response_422 = HTTPValidationError
|
|
|
6741
6741
|
* Response types for POST Domains endpoint
|
|
6742
6742
|
*
|
|
6743
6743
|
* Create a domain
|
|
6744
|
-
* Registers a new domain
|
|
6744
|
+
* Registers a new domain.
|
|
6745
|
+
|
|
6746
|
+
- **Premium domains** - when the registry classifies the domain as premium, an `expected_price` must be supplied to confirm the non-standard price returned by the availability check. See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
|
|
6747
|
+
- **Trademark claims (TMCH)** - when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_notice_acceptance_hash` must be supplied to acknowledge the corresponding claims notice. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
|
|
6745
6748
|
*
|
|
6746
6749
|
* @remarks
|
|
6747
6750
|
* This type defines all possible response structures for the POST Domains endpoint.
|
|
@@ -6757,10 +6760,11 @@ export type GET_Domains_Response_422 = HTTPValidationError
|
|
|
6757
6760
|
* @see {@link POST_Domains_Response_404} - 404 response type
|
|
6758
6761
|
* @see {@link POST_Domains_Response_409} - 409 response type
|
|
6759
6762
|
* @see {@link POST_Domains_Response_422} - 422 response type
|
|
6763
|
+
* @see {@link POST_Domains_Response_503} - 503 response type
|
|
6760
6764
|
*
|
|
6761
6765
|
|
|
6762
6766
|
*/
|
|
6763
|
-
export type POST_Domains_Response = POST_Domains_Response_201 | POST_Domains_Response_400 | POST_Domains_Response_404 | POST_Domains_Response_409 | POST_Domains_Response_422;
|
|
6767
|
+
export type POST_Domains_Response = POST_Domains_Response_201 | POST_Domains_Response_400 | POST_Domains_Response_404 | POST_Domains_Response_409 | POST_Domains_Response_422 | POST_Domains_Response_503;
|
|
6764
6768
|
|
|
6765
6769
|
/**
|
|
6766
6770
|
* 201 response for POST Domains endpoint
|
|
@@ -6843,9 +6847,26 @@ export type POST_Domains_Response_409 = Problem
|
|
|
6843
6847
|
* @path /v1/domains
|
|
6844
6848
|
*
|
|
6845
6849
|
* @see {@link POST_Domains_Response} - The main response type definition
|
|
6846
|
-
* @see {@link
|
|
6850
|
+
* @see {@link Problem} - The actual schema type definition
|
|
6851
|
+
*/
|
|
6852
|
+
export type POST_Domains_Response_422 = Problem
|
|
6853
|
+
|
|
6854
|
+
/**
|
|
6855
|
+
* 503 response for POST Domains endpoint
|
|
6856
|
+
*
|
|
6857
|
+
* @remarks
|
|
6858
|
+
* This type defines the response structure for the 503 status code
|
|
6859
|
+
* of the POST Domains endpoint.
|
|
6860
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
6861
|
+
*
|
|
6862
|
+
|
|
6863
|
+
*
|
|
6864
|
+
* @path /v1/domains
|
|
6865
|
+
*
|
|
6866
|
+
* @see {@link POST_Domains_Response} - The main response type definition
|
|
6867
|
+
* @see {@link Problem} - The actual schema type definition
|
|
6847
6868
|
*/
|
|
6848
|
-
export type
|
|
6869
|
+
export type POST_Domains_Response_503 = Problem
|
|
6849
6870
|
|
|
6850
6871
|
/**
|
|
6851
6872
|
* Response types for DELETE DomainsByDomainReference endpoint
|
|
@@ -7601,9 +7622,9 @@ export type DELETE_DomainsByDomainReferenceTransfer_Response_422 = HTTPValidatio
|
|
|
7601
7622
|
* Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
|
|
7602
7623
|
|
|
7603
7624
|
For each domain the response includes:
|
|
7604
|
-
- **Availability**
|
|
7605
|
-
- **
|
|
7606
|
-
- **
|
|
7625
|
+
- **Availability** - whether the domain can be registered, and the registry's reason if not.
|
|
7626
|
+
- **Premium status and pricing** - whether the domain is classified as premium by the registry, and if so, the price per action (create / renew / transfer / restore). See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
|
|
7627
|
+
- **Trademark claims (TMCH)** - when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_key` is returned. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
|
|
7607
7628
|
|
|
7608
7629
|
Domains are queried in parallel, grouped by registry connection. Availability and metadata reflect the registry's state at the moment of the call and are not cached.
|
|
7609
7630
|
*
|
|
@@ -7678,6 +7699,98 @@ include a mix of TLDs.
|
|
|
7678
7699
|
*/
|
|
7679
7700
|
export type GET_DomainsCheck_Response_422 = HTTPValidationError
|
|
7680
7701
|
|
|
7702
|
+
/**
|
|
7703
|
+
* Response types for POST DomainsClaimsNotices endpoint
|
|
7704
|
+
*
|
|
7705
|
+
* Retrieve claims notices from claim keys
|
|
7706
|
+
* Retrieves the trademark claims notice for a `claims_key` returned during a domain availability check. The response contains a `claims_notice_acceptance_hash` to acknowledge the notice when registering the domain, a ready-to-display `rendered_html`, and the structured fields needed to render a custom notice. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
|
|
7707
|
+
*
|
|
7708
|
+
* @remarks
|
|
7709
|
+
* This type defines all possible response structures for the POST DomainsClaimsNotices endpoint.
|
|
7710
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
7711
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
7712
|
+
*
|
|
7713
|
+
|
|
7714
|
+
*
|
|
7715
|
+
* @path /v1/domains/claims-notices
|
|
7716
|
+
*
|
|
7717
|
+
* @see {@link POST_DomainsClaimsNotices_Response_200} - 200 response type
|
|
7718
|
+
* @see {@link POST_DomainsClaimsNotices_Response_404} - 404 response type
|
|
7719
|
+
* @see {@link POST_DomainsClaimsNotices_Response_422} - 422 response type
|
|
7720
|
+
* @see {@link POST_DomainsClaimsNotices_Response_503} - 503 response type
|
|
7721
|
+
*
|
|
7722
|
+
|
|
7723
|
+
*/
|
|
7724
|
+
export type POST_DomainsClaimsNotices_Response = POST_DomainsClaimsNotices_Response_200 | POST_DomainsClaimsNotices_Response_404 | POST_DomainsClaimsNotices_Response_422 | POST_DomainsClaimsNotices_Response_503;
|
|
7725
|
+
|
|
7726
|
+
/**
|
|
7727
|
+
* 200 response for POST DomainsClaimsNotices endpoint
|
|
7728
|
+
*
|
|
7729
|
+
* @remarks
|
|
7730
|
+
* This type defines the response structure for the 200 status code
|
|
7731
|
+
* of the POST DomainsClaimsNotices endpoint.
|
|
7732
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7733
|
+
*
|
|
7734
|
+
|
|
7735
|
+
*
|
|
7736
|
+
* @path /v1/domains/claims-notices
|
|
7737
|
+
*
|
|
7738
|
+
* @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
|
|
7739
|
+
* @see {@link ClaimsNotices} - The actual schema type definition
|
|
7740
|
+
*/
|
|
7741
|
+
export type POST_DomainsClaimsNotices_Response_200 = ClaimsNotices
|
|
7742
|
+
|
|
7743
|
+
/**
|
|
7744
|
+
* 404 response for POST DomainsClaimsNotices endpoint
|
|
7745
|
+
*
|
|
7746
|
+
* @remarks
|
|
7747
|
+
* This type defines the response structure for the 404 status code
|
|
7748
|
+
* of the POST DomainsClaimsNotices endpoint.
|
|
7749
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7750
|
+
*
|
|
7751
|
+
|
|
7752
|
+
*
|
|
7753
|
+
* @path /v1/domains/claims-notices
|
|
7754
|
+
*
|
|
7755
|
+
* @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
|
|
7756
|
+
* @see {@link Problem} - The actual schema type definition
|
|
7757
|
+
*/
|
|
7758
|
+
export type POST_DomainsClaimsNotices_Response_404 = Problem
|
|
7759
|
+
|
|
7760
|
+
/**
|
|
7761
|
+
* 422 response for POST DomainsClaimsNotices endpoint
|
|
7762
|
+
*
|
|
7763
|
+
* @remarks
|
|
7764
|
+
* This type defines the response structure for the 422 status code
|
|
7765
|
+
* of the POST DomainsClaimsNotices endpoint.
|
|
7766
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7767
|
+
*
|
|
7768
|
+
|
|
7769
|
+
*
|
|
7770
|
+
* @path /v1/domains/claims-notices
|
|
7771
|
+
*
|
|
7772
|
+
* @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
|
|
7773
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
7774
|
+
*/
|
|
7775
|
+
export type POST_DomainsClaimsNotices_Response_422 = HTTPValidationError
|
|
7776
|
+
|
|
7777
|
+
/**
|
|
7778
|
+
* 503 response for POST DomainsClaimsNotices endpoint
|
|
7779
|
+
*
|
|
7780
|
+
* @remarks
|
|
7781
|
+
* This type defines the response structure for the 503 status code
|
|
7782
|
+
* of the POST DomainsClaimsNotices endpoint.
|
|
7783
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7784
|
+
*
|
|
7785
|
+
|
|
7786
|
+
*
|
|
7787
|
+
* @path /v1/domains/claims-notices
|
|
7788
|
+
*
|
|
7789
|
+
* @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
|
|
7790
|
+
* @see {@link Problem} - The actual schema type definition
|
|
7791
|
+
*/
|
|
7792
|
+
export type POST_DomainsClaimsNotices_Response_503 = Problem
|
|
7793
|
+
|
|
7681
7794
|
/**
|
|
7682
7795
|
* Response types for GET DomainsSummary endpoint
|
|
7683
7796
|
*
|
|
@@ -9331,9 +9444,9 @@ export type GET_EventsByEventId_Response = GET_EventsByEventId_Response_200 | GE
|
|
|
9331
9444
|
* @path /v1/events/{event_id}
|
|
9332
9445
|
*
|
|
9333
9446
|
* @see {@link GET_EventsByEventId_Response} - The main response type definition
|
|
9334
|
-
* @see {@link
|
|
9447
|
+
* @see {@link EventResponse} - The actual schema type definition
|
|
9335
9448
|
*/
|
|
9336
|
-
export type GET_EventsByEventId_Response_200 =
|
|
9449
|
+
export type GET_EventsByEventId_Response_200 = EventResponse
|
|
9337
9450
|
|
|
9338
9451
|
/**
|
|
9339
9452
|
* 401 response for GET EventsByEventId endpoint
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, Context, Conversation, DuplicateCommand, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, MemoryFact, Message, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, Context, Conversation, DuplicateCommand, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, VerificationRegistrantDetails, VerificationClaimType, VerificationDeadline, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, MemoryFact, Message, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, TmClassDesc, TmContact, TmHolder, TmCourt, TmUdrp, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* ContactIncludeField
|
|
@@ -205,6 +205,34 @@ export type TagTypeArray = TagType[];
|
|
|
205
205
|
* @see {@link TldResponseShort} - The individual TldResponseShort type definition
|
|
206
206
|
*/
|
|
207
207
|
export type TldResponseShortArray = TldResponseShort[];
|
|
208
|
+
/**
|
|
209
|
+
* TmClaim. A single trademark claim within a notice (claimType in RFC 9361)
|
|
210
|
+
*
|
|
211
|
+
* @remarks
|
|
212
|
+
* Array type for TmClaim objects. Used when the API returns a collection of TmClaim instances.
|
|
213
|
+
*
|
|
214
|
+
* @example
|
|
215
|
+
* ```typescript
|
|
216
|
+
* const items: TmClaimArray = await api.getTmClaims();
|
|
217
|
+
* ```
|
|
218
|
+
*
|
|
219
|
+
* @see {@link TmClaim} - The individual TmClaim type definition
|
|
220
|
+
*/
|
|
221
|
+
export type TmClaimArray = TmClaim[];
|
|
222
|
+
/**
|
|
223
|
+
* ClaimsNotice
|
|
224
|
+
*
|
|
225
|
+
* @remarks
|
|
226
|
+
* Array type for ClaimsNotice objects. Used when the API returns a collection of ClaimsNotice instances.
|
|
227
|
+
*
|
|
228
|
+
* @example
|
|
229
|
+
* ```typescript
|
|
230
|
+
* const items: ClaimsNoticeArray = await api.getClaimsNotices();
|
|
231
|
+
* ```
|
|
232
|
+
*
|
|
233
|
+
* @see {@link ClaimsNotice} - The individual ClaimsNotice type definition
|
|
234
|
+
*/
|
|
235
|
+
export type ClaimsNoticeArray = ClaimsNotice[];
|
|
208
236
|
/**
|
|
209
237
|
* AttributeCondition
|
|
210
238
|
*
|
|
@@ -877,6 +905,48 @@ export type DomainClientStatusArray = DomainClientStatus[];
|
|
|
877
905
|
* @see {@link DomainUpdateBulkInstance} - The individual DomainUpdateBulkInstance type definition
|
|
878
906
|
*/
|
|
879
907
|
export type DomainUpdateBulkInstanceArray = DomainUpdateBulkInstance[];
|
|
908
|
+
/**
|
|
909
|
+
* VerificationRegistrantDetails
|
|
910
|
+
*
|
|
911
|
+
* @remarks
|
|
912
|
+
* Array type for VerificationRegistrantDetails objects. Used when the API returns a collection of VerificationRegistrantDetails instances.
|
|
913
|
+
*
|
|
914
|
+
* @example
|
|
915
|
+
* ```typescript
|
|
916
|
+
* const items: VerificationRegistrantDetailsArray = await api.getVerificationRegistrantDetailss();
|
|
917
|
+
* ```
|
|
918
|
+
*
|
|
919
|
+
* @see {@link VerificationRegistrantDetails} - The individual VerificationRegistrantDetails type definition
|
|
920
|
+
*/
|
|
921
|
+
export type VerificationRegistrantDetailsArray = VerificationRegistrantDetails[];
|
|
922
|
+
/**
|
|
923
|
+
* VerificationClaimType
|
|
924
|
+
*
|
|
925
|
+
* @remarks
|
|
926
|
+
* Array type for VerificationClaimType objects. Used when the API returns a collection of VerificationClaimType instances.
|
|
927
|
+
*
|
|
928
|
+
* @example
|
|
929
|
+
* ```typescript
|
|
930
|
+
* const items: VerificationClaimTypeArray = await api.getVerificationClaimTypes();
|
|
931
|
+
* ```
|
|
932
|
+
*
|
|
933
|
+
* @see {@link VerificationClaimType} - The individual VerificationClaimType type definition
|
|
934
|
+
*/
|
|
935
|
+
export type VerificationClaimTypeArray = VerificationClaimType[];
|
|
936
|
+
/**
|
|
937
|
+
* VerificationDeadline
|
|
938
|
+
*
|
|
939
|
+
* @remarks
|
|
940
|
+
* Array type for VerificationDeadline objects. Used when the API returns a collection of VerificationDeadline instances.
|
|
941
|
+
*
|
|
942
|
+
* @example
|
|
943
|
+
* ```typescript
|
|
944
|
+
* const items: VerificationDeadlineArray = await api.getVerificationDeadlines();
|
|
945
|
+
* ```
|
|
946
|
+
*
|
|
947
|
+
* @see {@link VerificationDeadline} - The individual VerificationDeadline type definition
|
|
948
|
+
*/
|
|
949
|
+
export type VerificationDeadlineArray = VerificationDeadline[];
|
|
880
950
|
/**
|
|
881
951
|
* EmailForwardAliasCreate
|
|
882
952
|
*
|
|
@@ -1535,6 +1605,76 @@ export type LegalRequirementBaseArray = LegalRequirementBase[];
|
|
|
1535
1605
|
* @see {@link TldBase} - The individual TldBase type definition
|
|
1536
1606
|
*/
|
|
1537
1607
|
export type TldBaseArray = TldBase[];
|
|
1608
|
+
/**
|
|
1609
|
+
* TmClassDesc. Nice Classification description (classDescType in RFC 9361)
|
|
1610
|
+
*
|
|
1611
|
+
* @remarks
|
|
1612
|
+
* Array type for TmClassDesc objects. Used when the API returns a collection of TmClassDesc instances.
|
|
1613
|
+
*
|
|
1614
|
+
* @example
|
|
1615
|
+
* ```typescript
|
|
1616
|
+
* const items: TmClassDescArray = await api.getTmClassDescs();
|
|
1617
|
+
* ```
|
|
1618
|
+
*
|
|
1619
|
+
* @see {@link TmClassDesc} - The individual TmClassDesc type definition
|
|
1620
|
+
*/
|
|
1621
|
+
export type TmClassDescArray = TmClassDesc[];
|
|
1622
|
+
/**
|
|
1623
|
+
* TmContact. Contact / representative of the mark (contactType in RFC 9361)
|
|
1624
|
+
*
|
|
1625
|
+
* @remarks
|
|
1626
|
+
* Array type for TmContact objects. Used when the API returns a collection of TmContact instances.
|
|
1627
|
+
*
|
|
1628
|
+
* @example
|
|
1629
|
+
* ```typescript
|
|
1630
|
+
* const items: TmContactArray = await api.getTmContacts();
|
|
1631
|
+
* ```
|
|
1632
|
+
*
|
|
1633
|
+
* @see {@link TmContact} - The individual TmContact type definition
|
|
1634
|
+
*/
|
|
1635
|
+
export type TmContactArray = TmContact[];
|
|
1636
|
+
/**
|
|
1637
|
+
* TmHolder. Holder of the mark (holderType in RFC 9361). name or org must be set.
|
|
1638
|
+
*
|
|
1639
|
+
* @remarks
|
|
1640
|
+
* Array type for TmHolder objects. Used when the API returns a collection of TmHolder instances.
|
|
1641
|
+
*
|
|
1642
|
+
* @example
|
|
1643
|
+
* ```typescript
|
|
1644
|
+
* const items: TmHolderArray = await api.getTmHolders();
|
|
1645
|
+
* ```
|
|
1646
|
+
*
|
|
1647
|
+
* @see {@link TmHolder} - The individual TmHolder type definition
|
|
1648
|
+
*/
|
|
1649
|
+
export type TmHolderArray = TmHolder[];
|
|
1650
|
+
/**
|
|
1651
|
+
* TmCourt. Court resolution reference (courtType in RFC 9361)
|
|
1652
|
+
*
|
|
1653
|
+
* @remarks
|
|
1654
|
+
* Array type for TmCourt objects. Used when the API returns a collection of TmCourt instances.
|
|
1655
|
+
*
|
|
1656
|
+
* @example
|
|
1657
|
+
* ```typescript
|
|
1658
|
+
* const items: TmCourtArray = await api.getTmCourts();
|
|
1659
|
+
* ```
|
|
1660
|
+
*
|
|
1661
|
+
* @see {@link TmCourt} - The individual TmCourt type definition
|
|
1662
|
+
*/
|
|
1663
|
+
export type TmCourtArray = TmCourt[];
|
|
1664
|
+
/**
|
|
1665
|
+
* TmUdrp. UDRP case reference (udrpType in RFC 9361)
|
|
1666
|
+
*
|
|
1667
|
+
* @remarks
|
|
1668
|
+
* Array type for TmUdrp objects. Used when the API returns a collection of TmUdrp instances.
|
|
1669
|
+
*
|
|
1670
|
+
* @example
|
|
1671
|
+
* ```typescript
|
|
1672
|
+
* const items: TmUdrpArray = await api.getTmUdrps();
|
|
1673
|
+
* ```
|
|
1674
|
+
*
|
|
1675
|
+
* @see {@link TmUdrp} - The individual TmUdrp type definition
|
|
1676
|
+
*/
|
|
1677
|
+
export type TmUdrpArray = TmUdrp[];
|
|
1538
1678
|
/**
|
|
1539
1679
|
* PostTransferRequirements
|
|
1540
1680
|
*
|