@opusdns/api 0.289.0 → 0.290.0

package/src/helpers/requests.d.ts

@@ -34,7 +34,7 @@ import { operations } from '../schema';
 
 import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-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';
+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';
 
 /**
  * Request type for GET AiConciergeContextsContextId endpoint
@@ -3371,7 +3371,10 @@ export type GET_Domains_Request_Query = GET_Domains_Request['parameters']['query
  * Request type for POST Domains endpoint
  *
  * Create a domain
- * Registers a new domain
+ * Registers a new domain.
+
+- **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.
+- **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.
  *
  * @remarks
  * 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'];
  * Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
 
 For each domain the response includes:
-- **Availability** — whether the domain can be registered, and the registry's reason if not.
-- **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. The corresponding claims notice must be retrieved and acknowledged before the domain can be registered. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
-- **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.
+- **Availability** - whether the domain can be registered, and the registry's reason if not.
+- **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.
+- **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.
 
 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.
  *
@@ -3464,6 +3467,43 @@ include a mix of TLDs.
  */
 export type GET_DomainsCheck_Request_Query = GET_DomainsCheck_Request['parameters']['query'];
 
+/**
+ * Request type for POST DomainsClaimsNotices endpoint
+ *
+ * Retrieve claims notices from claim keys
+ * 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.
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST DomainsClaimsNotices endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/domains/claims-notices
+ *
+ * @see {@link POST_DomainsClaimsNotices_Request_Query} - Query parameters type
+ * @see {@link POST_DomainsClaimsNotices_Request_Path} - Path parameters type
+ * @see {@link POST_DomainsClaimsNotices_Request_Body} - Request body type
+ */
+export type POST_DomainsClaimsNotices_Request = {
+  requestBody: ClaimsNoticesRequest;
+}
+/**
+ * Request body for POST /v1/domains/claims-notices
+ *
+ * @remarks
+ * This type defines the request body structure for the POST /v1/domains/claims-notices 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/domains/claims-notices
+ */
+export type POST_DomainsClaimsNotices_Request_Body = POST_DomainsClaimsNotices_Request['requestBody'];
+
 /**
  * Request type for DELETE DomainsDomainReference endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-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, EventSchema, 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';
+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, EventSchema, 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';
 
 /**
  * Response types for GET AiConciergeContextsByContextId endpoint
@@ -6741,7 +6741,10 @@ export type GET_Domains_Response_422 = HTTPValidationError
  * Response types for POST Domains endpoint
  *
  * Create a domain
- * Registers a new domain
+ * Registers a new domain.
+
+- **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.
+- **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.
  *
  * @remarks
  * This type defines all possible response structures for the POST Domains endpoint.
@@ -6757,10 +6760,11 @@ export type GET_Domains_Response_422 = HTTPValidationError
  * @see {@link POST_Domains_Response_404} - 404 response type
  * @see {@link POST_Domains_Response_409} - 409 response type
  * @see {@link POST_Domains_Response_422} - 422 response type
+ * @see {@link POST_Domains_Response_503} - 503 response type
  *
 
  */
-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;
+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;
 
 /**
  * 201 response for POST Domains endpoint
@@ -6843,9 +6847,26 @@ export type POST_Domains_Response_409 = Problem
  * @path /v1/domains
  *
  * @see {@link POST_Domains_Response} - The main response type definition
- * @see {@link HTTPValidationError} - The actual schema type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_Domains_Response_422 = Problem
+
+/**
+ * 503 response for POST Domains endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 503 status code
+ * of the POST Domains endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains
+ *
+ * @see {@link POST_Domains_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
  */
-export type POST_Domains_Response_422 = HTTPValidationError
+export type POST_Domains_Response_503 = Problem
 
 /**
  * Response types for DELETE DomainsByDomainReference endpoint
@@ -7601,9 +7622,9 @@ export type DELETE_DomainsByDomainReferenceTransfer_Response_422 = HTTPValidatio
  * Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
 
 For each domain the response includes:
-- **Availability** — whether the domain can be registered, and the registry's reason if not.
-- **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. The corresponding claims notice must be retrieved and acknowledged before the domain can be registered. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
-- **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.
+- **Availability** - whether the domain can be registered, and the registry's reason if not.
+- **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.
+- **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.
 
 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.
  *
@@ -7678,6 +7699,98 @@ include a mix of TLDs.
  */
 export type GET_DomainsCheck_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST DomainsClaimsNotices endpoint
+ *
+ * Retrieve claims notices from claim keys
+ * 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.
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainsClaimsNotices endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/domains/claims-notices
+ *
+ * @see {@link POST_DomainsClaimsNotices_Response_200} - 200 response type
+ * @see {@link POST_DomainsClaimsNotices_Response_404} - 404 response type
+ * @see {@link POST_DomainsClaimsNotices_Response_422} - 422 response type
+ * @see {@link POST_DomainsClaimsNotices_Response_503} - 503 response type
+ *
+
+ */
+export type POST_DomainsClaimsNotices_Response = POST_DomainsClaimsNotices_Response_200 | POST_DomainsClaimsNotices_Response_404 | POST_DomainsClaimsNotices_Response_422 | POST_DomainsClaimsNotices_Response_503;
+
+/**
+ * 200 response for POST DomainsClaimsNotices endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST DomainsClaimsNotices endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/claims-notices
+ *
+ * @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
+ * @see {@link ClaimsNotices} - The actual schema type definition
+ */
+export type POST_DomainsClaimsNotices_Response_200 = ClaimsNotices
+
+/**
+ * 404 response for POST DomainsClaimsNotices endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST DomainsClaimsNotices endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/claims-notices
+ *
+ * @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainsClaimsNotices_Response_404 = Problem
+
+/**
+ * 422 response for POST DomainsClaimsNotices endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainsClaimsNotices endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/claims-notices
+ *
+ * @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainsClaimsNotices_Response_422 = HTTPValidationError
+
+/**
+ * 503 response for POST DomainsClaimsNotices endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 503 status code
+ * of the POST DomainsClaimsNotices endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/claims-notices
+ *
+ * @see {@link POST_DomainsClaimsNotices_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainsClaimsNotices_Response_503 = Problem
+
 /**
  * Response types for GET DomainsSummary endpoint
  *

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-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';
+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, 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';
 
 /**
  * ContactIncludeField
@@ -205,6 +205,34 @@ export type TagTypeArray = TagType[];
  * @see {@link TldResponseShort} - The individual TldResponseShort type definition
  */
 export type TldResponseShortArray = TldResponseShort[];
+/**
+ * TmClaim. A single trademark claim within a notice (claimType in RFC 9361)
+ *
+ * @remarks
+ * Array type for TmClaim objects. Used when the API returns a collection of TmClaim instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TmClaimArray = await api.getTmClaims();
+ * ```
+ *
+ * @see {@link TmClaim} - The individual TmClaim type definition
+ */
+export type TmClaimArray = TmClaim[];
+/**
+ * ClaimsNotice
+ *
+ * @remarks
+ * Array type for ClaimsNotice objects. Used when the API returns a collection of ClaimsNotice instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ClaimsNoticeArray = await api.getClaimsNotices();
+ * ```
+ *
+ * @see {@link ClaimsNotice} - The individual ClaimsNotice type definition
+ */
+export type ClaimsNoticeArray = ClaimsNotice[];
 /**
  * AttributeCondition
  *
@@ -1535,6 +1563,76 @@ export type LegalRequirementBaseArray = LegalRequirementBase[];
  * @see {@link TldBase} - The individual TldBase type definition
  */
 export type TldBaseArray = TldBase[];
+/**
+ * TmClassDesc. Nice Classification description (classDescType in RFC 9361)
+ *
+ * @remarks
+ * Array type for TmClassDesc objects. Used when the API returns a collection of TmClassDesc instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TmClassDescArray = await api.getTmClassDescs();
+ * ```
+ *
+ * @see {@link TmClassDesc} - The individual TmClassDesc type definition
+ */
+export type TmClassDescArray = TmClassDesc[];
+/**
+ * TmContact. Contact / representative of the mark (contactType in RFC 9361)
+ *
+ * @remarks
+ * Array type for TmContact objects. Used when the API returns a collection of TmContact instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TmContactArray = await api.getTmContacts();
+ * ```
+ *
+ * @see {@link TmContact} - The individual TmContact type definition
+ */
+export type TmContactArray = TmContact[];
+/**
+ * TmHolder. Holder of the mark (holderType in RFC 9361). name or org must be set.
+ *
+ * @remarks
+ * Array type for TmHolder objects. Used when the API returns a collection of TmHolder instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TmHolderArray = await api.getTmHolders();
+ * ```
+ *
+ * @see {@link TmHolder} - The individual TmHolder type definition
+ */
+export type TmHolderArray = TmHolder[];
+/**
+ * TmCourt. Court resolution reference (courtType in RFC 9361)
+ *
+ * @remarks
+ * Array type for TmCourt objects. Used when the API returns a collection of TmCourt instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TmCourtArray = await api.getTmCourts();
+ * ```
+ *
+ * @see {@link TmCourt} - The individual TmCourt type definition
+ */
+export type TmCourtArray = TmCourt[];
+/**
+ * TmUdrp. UDRP case reference (udrpType in RFC 9361)
+ *
+ * @remarks
+ * Array type for TmUdrp objects. Used when the API returns a collection of TmUdrp instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TmUdrpArray = await api.getTmUdrps();
+ * ```
+ *
+ * @see {@link TmUdrp} - The individual TmUdrp type definition
+ */
+export type TmUdrpArray = TmUdrp[];
 /**
  * PostTransferRequirements
  *

package/src/helpers/schemas.d.ts

@@ -266,6 +266,54 @@ export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type BulkObjectTagChanges = components['schemas']['BulkObjectTagChanges'];
+/**
+ * ClaimsNotice
+ *
+ * @remarks
+ * Type alias for the `ClaimsNotice` OpenAPI schema.
+ * This type represents claimsnotice data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getClaimsNotice();
+ * const item: ClaimsNotice = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ClaimsNotice = components['schemas']['ClaimsNotice'];
+/**
+ * ClaimsNoticesRequest
+ *
+ * @remarks
+ * Type alias for the `ClaimsNoticesRequest` OpenAPI schema.
+ * This type represents claimsnoticesrequest data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getClaimsNoticesRequest();
+ * const item: ClaimsNoticesRequest = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ClaimsNoticesRequest = components['schemas']['ClaimsNoticesRequest'];
+/**
+ * ClaimsNoticesResponse
+ *
+ * @remarks
+ * Type alias for the `ClaimsNoticesResponse` OpenAPI schema.
+ * This type represents claimsnoticesresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getClaimsNotices();
+ * const item: ClaimsNotices = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ClaimsNotices = components['schemas']['ClaimsNoticesResponse'];
 /**
  * CommandError
  *
@@ -682,6 +730,22 @@ export type ContactSchema = components['schemas']['ContactSchema'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactSortField = components['schemas']['ContactSortField'];
+/**
+ * ContactType
+ *
+ * @remarks
+ * Type alias for the `ContactType` OpenAPI schema.
+ * This type represents contacttype data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactType();
+ * const item: ContactType = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactType = components['schemas']['ContactType'];
 /**
  * ContactVerificationApiResponse
  *
@@ -3503,6 +3567,22 @@ export type HTTPMethod = components['schemas']['HTTPMethod'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type HTTPValidationError = components['schemas']['HTTPValidationError'];
+/**
+ * HolderEntitlement
+ *
+ * @remarks
+ * Type alias for the `HolderEntitlement` OpenAPI schema.
+ * This type represents holderentitlement data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getHolderEntitlement();
+ * const item: HolderEntitlement = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type HolderEntitlement = components['schemas']['HolderEntitlement'];
 /**
  * HostSchema
  *
@@ -6228,6 +6308,150 @@ export type TldResponseShort = components['schemas']['TldResponseShort'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type TldSpecification = components['schemas']['TldSpecificationResponse'];
+/**
+ * TmAddr. Address information (addrType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmAddr` OpenAPI schema.
+ * This type represents tmaddr data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmAddr();
+ * const item: TmAddr = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmAddr = components['schemas']['TmAddr'];
+/**
+ * TmClaim. A single trademark claim within a notice (claimType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmClaim` OpenAPI schema.
+ * This type represents tmclaim data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmClaim();
+ * const item: TmClaim = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmClaim = components['schemas']['TmClaim'];
+/**
+ * TmClassDesc. Nice Classification description (classDescType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmClassDesc` OpenAPI schema.
+ * This type represents tmclassdesc data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmClassDesc();
+ * const item: TmClassDesc = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmClassDesc = components['schemas']['TmClassDesc'];
+/**
+ * TmContact. Contact / representative of the mark (contactType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmContact` OpenAPI schema.
+ * This type represents tmcontact data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmContact();
+ * const item: TmContact = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmContact = components['schemas']['TmContact'];
+/**
+ * TmCourt. Court resolution reference (courtType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmCourt` OpenAPI schema.
+ * This type represents tmcourt data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmCourt();
+ * const item: TmCourt = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmCourt = components['schemas']['TmCourt'];
+/**
+ * TmHolder. Holder of the mark (holderType in RFC 9361). name or org must be set.
+ *
+ * @remarks
+ * Type alias for the `TmHolder` OpenAPI schema.
+ * This type represents tmholder data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmHolder();
+ * const item: TmHolder = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmHolder = components['schemas']['TmHolder'];
+/**
+ * TmJurDesc. Jurisdiction description (jurDescType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmJurDesc` OpenAPI schema.
+ * This type represents tmjurdesc data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmJurDesc();
+ * const item: TmJurDesc = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmJurDesc = components['schemas']['TmJurDesc'];
+/**
+ * TmNotExactMatch. Signals claim was added by non-exact match rules (noExactMatchType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmNotExactMatch` OpenAPI schema.
+ * This type represents tmnotexactmatch data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmNotExactMatch();
+ * const item: TmNotExactMatch = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmNotExactMatch = components['schemas']['TmNotExactMatch'];
+/**
+ * TmUdrp. UDRP case reference (udrpType in RFC 9361)
+ *
+ * @remarks
+ * Type alias for the `TmUdrp` OpenAPI schema.
+ * This type represents tmudrp data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTmUdrp();
+ * const item: TmUdrp = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TmUdrp = components['schemas']['TmUdrp'];
 /**
  * TrademarkClaimsBase
  *