@opusdns/api 0.211.0 → 0.212.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 +55 -1
- package/src/helpers/requests.d.ts +0 -2
- package/src/helpers/responses.d.ts +0 -3
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +30 -4
- package/src/schema.d.ts +8 -1
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -467,6 +467,60 @@ export const CONDITION_OPERATOR_VALUES = [
|
|
|
467
467
|
'not_in'
|
|
468
468
|
] as const satisfies [string, ...string[]] | ConditionOperator[];
|
|
469
469
|
|
|
470
|
+
/**
|
|
471
|
+
* ContactAttributeSetSortField. Auto-generated enum for ContactAttributeSetSortField
|
|
472
|
+
*
|
|
473
|
+
* @remarks
|
|
474
|
+
* This constant provides both object and array forms for the ContactAttributeSetSortField enum.
|
|
475
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
476
|
+
*
|
|
477
|
+
* @example
|
|
478
|
+
* ```typescript
|
|
479
|
+
* // Using the object form for key-value access
|
|
480
|
+
* const status = CONTACT_ATTRIBUTE_SET_SORT_FIELD.SUCCESS;
|
|
481
|
+
*
|
|
482
|
+
* // Using the array form for iteration
|
|
483
|
+
* const allStatuses = CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES;
|
|
484
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
485
|
+
* ```
|
|
486
|
+
*
|
|
487
|
+
* @see {@link ContactAttributeSetSortField} - The TypeScript type definition
|
|
488
|
+
*/
|
|
489
|
+
export const CONTACT_ATTRIBUTE_SET_SORT_FIELD = {
|
|
490
|
+
LABEL: "label",
|
|
491
|
+
TLD: "tld",
|
|
492
|
+
CREATED_ON: "created_on",
|
|
493
|
+
UPDATED_ON: "updated_on",
|
|
494
|
+
} as const satisfies Record<string, ContactAttributeSetSortField>;
|
|
495
|
+
|
|
496
|
+
/**
|
|
497
|
+
* Array of all ContactAttributeSetSortField enum values
|
|
498
|
+
*
|
|
499
|
+
* @remarks
|
|
500
|
+
* This constant provides a array containing all valid ContactAttributeSetSortField enum values.
|
|
501
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
502
|
+
*
|
|
503
|
+
* @example
|
|
504
|
+
* ```typescript
|
|
505
|
+
* // Iterating through all values
|
|
506
|
+
* for (const value of CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES) {
|
|
507
|
+
* console.log(`Processing: ${value}`);
|
|
508
|
+
* }
|
|
509
|
+
*
|
|
510
|
+
* // Validation
|
|
511
|
+
* const isValid = CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES.includes(someValue);
|
|
512
|
+
* ```
|
|
513
|
+
*
|
|
514
|
+
* @see {@link ContactAttributeSetSortField} - The TypeScript type definition
|
|
515
|
+
* @see {@link CONTACT_ATTRIBUTE_SET_SORT_FIELD} - The object form of this enum
|
|
516
|
+
*/
|
|
517
|
+
export const CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES = [
|
|
518
|
+
'label',
|
|
519
|
+
'tld',
|
|
520
|
+
'created_on',
|
|
521
|
+
'updated_on'
|
|
522
|
+
] as const satisfies [string, ...string[]] | ContactAttributeSetSortField[];
|
|
523
|
+
|
|
470
524
|
/**
|
|
471
525
|
* ContactSortField. Auto-generated enum for ContactSortField
|
|
472
526
|
*
|
|
@@ -475,7 +475,6 @@ export type POST_Contacts_Request_Body = POST_Contacts_Request['requestBody'];
|
|
|
475
475
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
476
476
|
*
|
|
477
477
|
* @path /v1/contacts/attribute-sets
|
|
478
|
-
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
479
478
|
*
|
|
480
479
|
* @see {@link GET_ContactsAttributeSets_Request_Query} - Query parameters type
|
|
481
480
|
* @see {@link GET_ContactsAttributeSets_Request_Path} - Path parameters type
|
|
@@ -497,7 +496,6 @@ export type GET_ContactsAttributeSets_Request = {
|
|
|
497
496
|
* Use this type to ensure type safety for query parameters.
|
|
498
497
|
*
|
|
499
498
|
* @path /v1/contacts/attribute-sets
|
|
500
|
-
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
501
499
|
*/
|
|
502
500
|
export type GET_ContactsAttributeSets_Request_Query = GET_ContactsAttributeSets_Request['parameters']['query'];
|
|
503
501
|
|
|
@@ -689,7 +689,6 @@ export type POST_Contacts_Response_422 = HTTPValidationError
|
|
|
689
689
|
|
|
690
690
|
*
|
|
691
691
|
* @path /v1/contacts/attribute-sets
|
|
692
|
-
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
693
692
|
*
|
|
694
693
|
* @see {@link GET_ContactsAttributeSets_Response_200} - 200 response type
|
|
695
694
|
* @see {@link GET_ContactsAttributeSets_Response_422} - 422 response type
|
|
@@ -709,7 +708,6 @@ export type GET_ContactsAttributeSets_Response = GET_ContactsAttributeSets_Respo
|
|
|
709
708
|
|
|
710
709
|
*
|
|
711
710
|
* @path /v1/contacts/attribute-sets
|
|
712
|
-
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
713
711
|
*
|
|
714
712
|
* @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
|
|
715
713
|
* @see {@link Pagination_ContactAttributeSet} - The actual schema type definition
|
|
@@ -727,7 +725,6 @@ export type GET_ContactsAttributeSets_Response_200 = Pagination_ContactAttribute
|
|
|
727
725
|
|
|
728
726
|
*
|
|
729
727
|
* @path /v1/contacts/attribute-sets
|
|
730
|
-
* @param tld (query) - Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
731
728
|
*
|
|
732
729
|
* @see {@link GET_ContactsAttributeSets_Response} - The main response type definition
|
|
733
730
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -330,6 +330,22 @@ export type ContactAttributeSetCreate = components['schemas']['ContactAttributeS
|
|
|
330
330
|
* @see {@link components} - The OpenAPI components schema definition
|
|
331
331
|
*/
|
|
332
332
|
export type ContactAttributeSet = components['schemas']['ContactAttributeSetResponse'];
|
|
333
|
+
/**
|
|
334
|
+
* ContactAttributeSetSortField
|
|
335
|
+
*
|
|
336
|
+
* @remarks
|
|
337
|
+
* Type alias for the `ContactAttributeSetSortField` OpenAPI schema.
|
|
338
|
+
* This type represents contactattributesetsortfield data structures used in API requests and responses.
|
|
339
|
+
*
|
|
340
|
+
* @example
|
|
341
|
+
* ```typescript
|
|
342
|
+
* const response = await api.getContactAttributeSetSortField();
|
|
343
|
+
* const item: ContactAttributeSetSortField = response.results;
|
|
344
|
+
* ```
|
|
345
|
+
*
|
|
346
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
347
|
+
*/
|
|
348
|
+
export type ContactAttributeSetSortField = components['schemas']['ContactAttributeSetSortField'];
|
|
333
349
|
/**
|
|
334
350
|
* ContactAttributeSetUpdate
|
|
335
351
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -477,6 +477,14 @@ components:
|
|
|
477
477
|
- updated_on
|
|
478
478
|
title: ContactAttributeSetResponse
|
|
479
479
|
type: object
|
|
480
|
+
ContactAttributeSetSortField:
|
|
481
|
+
enum:
|
|
482
|
+
- label
|
|
483
|
+
- tld
|
|
484
|
+
- created_on
|
|
485
|
+
- updated_on
|
|
486
|
+
title: ContactAttributeSetSortField
|
|
487
|
+
type: string
|
|
480
488
|
ContactAttributeSetUpdate:
|
|
481
489
|
properties:
|
|
482
490
|
label:
|
|
@@ -7218,7 +7226,7 @@ info:
|
|
|
7218
7226
|
'
|
|
7219
7227
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
7220
7228
|
title: OpusDNS API
|
|
7221
|
-
version: 2026-03-02-
|
|
7229
|
+
version: 2026-03-02-095654
|
|
7222
7230
|
x-logo:
|
|
7223
7231
|
altText: OpusDNS API Reference
|
|
7224
7232
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8170,16 +8178,34 @@ paths:
|
|
|
8170
8178
|
get:
|
|
8171
8179
|
operationId: list_attribute_sets_v1_contacts_attribute_sets_get
|
|
8172
8180
|
parameters:
|
|
8173
|
-
-
|
|
8174
|
-
|
|
8181
|
+
- in: query
|
|
8182
|
+
name: sort_by
|
|
8183
|
+
required: false
|
|
8184
|
+
schema:
|
|
8185
|
+
$ref: '#/components/schemas/ContactAttributeSetSortField'
|
|
8186
|
+
default: created_on
|
|
8187
|
+
- in: query
|
|
8188
|
+
name: sort_order
|
|
8189
|
+
required: false
|
|
8190
|
+
schema:
|
|
8191
|
+
$ref: '#/components/schemas/SortOrder'
|
|
8192
|
+
default: desc
|
|
8193
|
+
- in: query
|
|
8175
8194
|
name: tld
|
|
8176
8195
|
required: false
|
|
8177
8196
|
schema:
|
|
8178
8197
|
anyOf:
|
|
8179
8198
|
- type: string
|
|
8180
8199
|
- type: 'null'
|
|
8181
|
-
description: Filter by TLD (e.g. 'de', '.de', 'DE')
|
|
8182
8200
|
title: Tld
|
|
8201
|
+
- in: query
|
|
8202
|
+
name: label
|
|
8203
|
+
required: false
|
|
8204
|
+
schema:
|
|
8205
|
+
anyOf:
|
|
8206
|
+
- type: string
|
|
8207
|
+
- type: 'null'
|
|
8208
|
+
title: Label
|
|
8183
8209
|
- in: query
|
|
8184
8210
|
name: page
|
|
8185
8211
|
required: false
|
package/src/schema.d.ts
CHANGED
|
@@ -2263,6 +2263,11 @@ export interface components {
|
|
|
2263
2263
|
*/
|
|
2264
2264
|
updated_on: Date;
|
|
2265
2265
|
};
|
|
2266
|
+
/**
|
|
2267
|
+
* ContactAttributeSetSortField
|
|
2268
|
+
* @enum {string}
|
|
2269
|
+
*/
|
|
2270
|
+
ContactAttributeSetSortField: "label" | "tld" | "created_on" | "updated_on";
|
|
2266
2271
|
/** ContactAttributeSetUpdate */
|
|
2267
2272
|
ContactAttributeSetUpdate: {
|
|
2268
2273
|
/**
|
|
@@ -7178,8 +7183,10 @@ export interface operations {
|
|
|
7178
7183
|
list_attribute_sets_v1_contacts_attribute_sets_get: {
|
|
7179
7184
|
parameters: {
|
|
7180
7185
|
query?: {
|
|
7181
|
-
|
|
7186
|
+
sort_by?: components["schemas"]["ContactAttributeSetSortField"];
|
|
7187
|
+
sort_order?: components["schemas"]["SortOrder"];
|
|
7182
7188
|
tld?: string | null;
|
|
7189
|
+
label?: string | null;
|
|
7183
7190
|
page?: number;
|
|
7184
7191
|
page_size?: number;
|
|
7185
7192
|
};
|