@opusdns/api 0.304.0 → 0.305.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/keys.ts +26 -0
- package/src/helpers/requests.d.ts +2 -0
- package/src/helpers/responses.d.ts +3 -0
- package/src/helpers/schemas-arrays.d.ts +29 -29
- package/src/openapi.yaml +28 -1
- package/src/schema.d.ts +8 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -5222,6 +5222,31 @@ export const KEY_CONTACT_POSTAL_CODE: keyof Contact = 'postal_code';
|
|
|
5222
5222
|
* @see {@link KEYS_CONTACT} - Array of all keys for this type
|
|
5223
5223
|
*/
|
|
5224
5224
|
export const KEY_CONTACT_STATE: keyof Contact = 'state';
|
|
5225
|
+
/**
|
|
5226
|
+
* Status Tags
|
|
5227
|
+
*
|
|
5228
|
+
* Status tags assigned to this contact. Only included when ?include=tags is specified.
|
|
5229
|
+
*
|
|
5230
|
+
*
|
|
5231
|
+
*
|
|
5232
|
+
* @remarks
|
|
5233
|
+
* This key constant provides type-safe access to the `status_tags` property of Contact objects.
|
|
5234
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
5235
|
+
*
|
|
5236
|
+
* @example
|
|
5237
|
+
* ```typescript
|
|
5238
|
+
* // Direct property access
|
|
5239
|
+
* const value = contact[KEY_CONTACT_STATUS_TAGS];
|
|
5240
|
+
*
|
|
5241
|
+
* // Dynamic property access
|
|
5242
|
+
* const propertyName = KEY_CONTACT_STATUS_TAGS;
|
|
5243
|
+
* const value = contact[propertyName];
|
|
5244
|
+
* ```
|
|
5245
|
+
*
|
|
5246
|
+
* @see {@link Contact} - The TypeScript type definition
|
|
5247
|
+
* @see {@link KEYS_CONTACT} - Array of all keys for this type
|
|
5248
|
+
*/
|
|
5249
|
+
export const KEY_CONTACT_STATUS_TAGS: keyof Contact = 'status_tags';
|
|
5225
5250
|
/**
|
|
5226
5251
|
* Street
|
|
5227
5252
|
*
|
|
@@ -5335,6 +5360,7 @@ export const KEYS_CONTACT = [
|
|
|
5335
5360
|
KEY_CONTACT_PHONE,
|
|
5336
5361
|
KEY_CONTACT_POSTAL_CODE,
|
|
5337
5362
|
KEY_CONTACT_STATE,
|
|
5363
|
+
KEY_CONTACT_STATUS_TAGS,
|
|
5338
5364
|
KEY_CONTACT_STREET,
|
|
5339
5365
|
KEY_CONTACT_TAGS,
|
|
5340
5366
|
KEY_CONTACT_TITLE,
|
|
@@ -1113,6 +1113,7 @@ export type POST_AvailabilityStream_Request_Body = POST_AvailabilityStream_Reque
|
|
|
1113
1113
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1114
1114
|
*
|
|
1115
1115
|
* @path /v1/contacts
|
|
1116
|
+
* @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
|
|
1116
1117
|
* @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
|
|
1117
1118
|
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
1118
1119
|
*
|
|
@@ -1136,6 +1137,7 @@ export type GET_Contacts_Request = {
|
|
|
1136
1137
|
* Use this type to ensure type safety for query parameters.
|
|
1137
1138
|
*
|
|
1138
1139
|
* @path /v1/contacts
|
|
1140
|
+
* @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
|
|
1139
1141
|
* @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
|
|
1140
1142
|
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
1141
1143
|
*/
|
|
@@ -2201,6 +2201,7 @@ export type POST_AvailabilityStream_Response_422 = HTTPValidationError
|
|
|
2201
2201
|
|
|
2202
2202
|
*
|
|
2203
2203
|
* @path /v1/contacts
|
|
2204
|
+
* @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
|
|
2204
2205
|
* @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
|
|
2205
2206
|
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
2206
2207
|
*
|
|
@@ -2222,6 +2223,7 @@ export type GET_Contacts_Response = GET_Contacts_Response_200 | GET_Contacts_Res
|
|
|
2222
2223
|
|
|
2223
2224
|
*
|
|
2224
2225
|
* @path /v1/contacts
|
|
2226
|
+
* @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
|
|
2225
2227
|
* @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
|
|
2226
2228
|
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
2227
2229
|
*
|
|
@@ -2241,6 +2243,7 @@ export type GET_Contacts_Response_200 = Pagination_Contact
|
|
|
2241
2243
|
|
|
2242
2244
|
*
|
|
2243
2245
|
* @path /v1/contacts
|
|
2246
|
+
* @param status_tags (query) - Filter by status tag types. Can be specified multiple times.
|
|
2244
2247
|
* @param tag_ids (query) - Filter by user tag IDs. Can be specified multiple times.
|
|
2245
2248
|
* @param include (query) - Include additional data in the response. Can be specified multiple times.
|
|
2246
2249
|
*
|
|
@@ -21,8 +21,22 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { ContactIncludeField, ZoneIncludeField,
|
|
24
|
+
import { StatusTagType, ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, StatusTag, 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
|
+
/**
|
|
27
|
+
* StatusTagType
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* Array type for StatusTagType objects. Used when the API returns a collection of StatusTagType instances.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```typescript
|
|
34
|
+
* const items: StatusTagTypeArray = await api.getStatusTagTypes();
|
|
35
|
+
* ```
|
|
36
|
+
*
|
|
37
|
+
* @see {@link StatusTagType} - The individual StatusTagType type definition
|
|
38
|
+
*/
|
|
39
|
+
export type StatusTagTypeArray = StatusTagType[];
|
|
26
40
|
/**
|
|
27
41
|
* ContactIncludeField
|
|
28
42
|
*
|
|
@@ -51,20 +65,6 @@ export type ContactIncludeFieldArray = ContactIncludeField[];
|
|
|
51
65
|
* @see {@link ZoneIncludeField} - The individual ZoneIncludeField type definition
|
|
52
66
|
*/
|
|
53
67
|
export type ZoneIncludeFieldArray = ZoneIncludeField[];
|
|
54
|
-
/**
|
|
55
|
-
* StatusTagType
|
|
56
|
-
*
|
|
57
|
-
* @remarks
|
|
58
|
-
* Array type for StatusTagType objects. Used when the API returns a collection of StatusTagType instances.
|
|
59
|
-
*
|
|
60
|
-
* @example
|
|
61
|
-
* ```typescript
|
|
62
|
-
* const items: StatusTagTypeArray = await api.getStatusTagTypes();
|
|
63
|
-
* ```
|
|
64
|
-
*
|
|
65
|
-
* @see {@link StatusTagType} - The individual StatusTagType type definition
|
|
66
|
-
*/
|
|
67
|
-
export type StatusTagTypeArray = StatusTagType[];
|
|
68
68
|
/**
|
|
69
69
|
* DomainIncludeField
|
|
70
70
|
*
|
|
@@ -303,6 +303,20 @@ export type ContactCreateBulkInstanceArray = ContactCreateBulkInstance[];
|
|
|
303
303
|
* @see {@link ContactAttributeLinkDetail} - The individual ContactAttributeLinkDetail type definition
|
|
304
304
|
*/
|
|
305
305
|
export type ContactAttributeLinkDetailArray = ContactAttributeLinkDetail[];
|
|
306
|
+
/**
|
|
307
|
+
* StatusTagResponse
|
|
308
|
+
*
|
|
309
|
+
* @remarks
|
|
310
|
+
* Array type for StatusTagResponse objects. Used when the API returns a collection of StatusTagResponse instances.
|
|
311
|
+
*
|
|
312
|
+
* @example
|
|
313
|
+
* ```typescript
|
|
314
|
+
* const items: StatusTagArray = await api.getStatusTags();
|
|
315
|
+
* ```
|
|
316
|
+
*
|
|
317
|
+
* @see {@link StatusTag} - The individual StatusTagResponse type definition
|
|
318
|
+
*/
|
|
319
|
+
export type StatusTagArray = StatusTag[];
|
|
306
320
|
/**
|
|
307
321
|
* TagEnrichedResponse
|
|
308
322
|
*
|
|
@@ -849,20 +863,6 @@ export type DomainContactArray = DomainContact[];
|
|
|
849
863
|
* @see {@link DomainHost} - The individual DomainHostResponse type definition
|
|
850
864
|
*/
|
|
851
865
|
export type DomainHostArray = DomainHost[];
|
|
852
|
-
/**
|
|
853
|
-
* StatusTagResponse
|
|
854
|
-
*
|
|
855
|
-
* @remarks
|
|
856
|
-
* Array type for StatusTagResponse objects. Used when the API returns a collection of StatusTagResponse instances.
|
|
857
|
-
*
|
|
858
|
-
* @example
|
|
859
|
-
* ```typescript
|
|
860
|
-
* const items: StatusTagArray = await api.getStatusTags();
|
|
861
|
-
* ```
|
|
862
|
-
*
|
|
863
|
-
* @see {@link StatusTag} - The individual StatusTagResponse type definition
|
|
864
|
-
*/
|
|
865
|
-
export type StatusTagArray = StatusTag[];
|
|
866
866
|
/**
|
|
867
867
|
* DomainSearchSuggestionWithPrice
|
|
868
868
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1304,6 +1304,15 @@ components:
|
|
|
1304
1304
|
- type: 'null'
|
|
1305
1305
|
description: The state of the contact
|
|
1306
1306
|
title: State
|
|
1307
|
+
status_tags:
|
|
1308
|
+
anyOf:
|
|
1309
|
+
- items:
|
|
1310
|
+
$ref: '#/components/schemas/StatusTagResponse'
|
|
1311
|
+
type: array
|
|
1312
|
+
- type: 'null'
|
|
1313
|
+
description: Status tags assigned to this contact. Only included when ?include=tags
|
|
1314
|
+
is specified.
|
|
1315
|
+
title: Status Tags
|
|
1307
1316
|
street:
|
|
1308
1317
|
description: The address of the contact
|
|
1309
1318
|
maxLength: 255
|
|
@@ -11346,7 +11355,7 @@ info:
|
|
|
11346
11355
|
\n\n"
|
|
11347
11356
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
11348
11357
|
title: OpusDNS API
|
|
11349
|
-
version: 2026-05-18-
|
|
11358
|
+
version: 2026-05-18-155947
|
|
11350
11359
|
x-logo:
|
|
11351
11360
|
altText: OpusDNS API Reference
|
|
11352
11361
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -13368,6 +13377,24 @@ paths:
|
|
|
13368
13377
|
schema:
|
|
13369
13378
|
$ref: '#/components/schemas/SortOrder'
|
|
13370
13379
|
default: desc
|
|
13380
|
+
- description: Filter by status tag types. Can be specified multiple times.
|
|
13381
|
+
in: query
|
|
13382
|
+
name: status_tags
|
|
13383
|
+
required: false
|
|
13384
|
+
schema:
|
|
13385
|
+
anyOf:
|
|
13386
|
+
- items:
|
|
13387
|
+
$ref: '#/components/schemas/StatusTagType'
|
|
13388
|
+
type: array
|
|
13389
|
+
- type: 'null'
|
|
13390
|
+
description: Filter by status tag types. Can be specified multiple times.
|
|
13391
|
+
title: Status Tags
|
|
13392
|
+
- in: query
|
|
13393
|
+
name: status_tag_mode
|
|
13394
|
+
required: false
|
|
13395
|
+
schema:
|
|
13396
|
+
$ref: '#/components/schemas/TagFilterMode'
|
|
13397
|
+
default: match_any
|
|
13371
13398
|
- description: Filter by user tag IDs. Can be specified multiple times.
|
|
13372
13399
|
in: query
|
|
13373
13400
|
name: tag_ids
|
package/src/schema.d.ts
CHANGED
|
@@ -3365,6 +3365,11 @@ export interface components {
|
|
|
3365
3365
|
* @description The state of the contact
|
|
3366
3366
|
*/
|
|
3367
3367
|
state?: string | null;
|
|
3368
|
+
/**
|
|
3369
|
+
* Status Tags
|
|
3370
|
+
* @description Status tags assigned to this contact. Only included when ?include=tags is specified.
|
|
3371
|
+
*/
|
|
3372
|
+
status_tags?: components["schemas"]["StatusTagResponse"][] | null;
|
|
3368
3373
|
/**
|
|
3369
3374
|
* Street
|
|
3370
3375
|
* @description The address of the contact
|
|
@@ -11587,6 +11592,9 @@ export interface operations {
|
|
|
11587
11592
|
query?: {
|
|
11588
11593
|
sort_by?: components["schemas"]["ContactSortField"];
|
|
11589
11594
|
sort_order?: components["schemas"]["SortOrder"];
|
|
11595
|
+
/** @description Filter by status tag types. Can be specified multiple times. */
|
|
11596
|
+
status_tags?: components["schemas"]["StatusTagType"][] | null;
|
|
11597
|
+
status_tag_mode?: components["schemas"]["TagFilterMode"];
|
|
11590
11598
|
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
11591
11599
|
tag_ids?: TypeId<"tag">[] | null;
|
|
11592
11600
|
tag_mode?: components["schemas"]["TagFilterMode"];
|