@opusdns/api 1.207.0 → 1.208.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 +9 -0
- package/src/helpers/keys.ts +13 -0
- package/src/helpers/schemas.d.ts +2 -0
- package/src/openapi.yaml +38 -5
- package/src/schema.d.ts +25 -3
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -15,6 +15,7 @@ import type {
|
|
|
15
15
|
ContactAttributeSetSortField,
|
|
16
16
|
ContactIncludeField,
|
|
17
17
|
ContactSortField,
|
|
18
|
+
ContactStatusTagType,
|
|
18
19
|
ContactType,
|
|
19
20
|
ContactVerificationClaim,
|
|
20
21
|
ContactVerificationMethod,
|
|
@@ -384,6 +385,14 @@ export const CONTACT_SORT_FIELD_VALUES = [
|
|
|
384
385
|
'created_on',
|
|
385
386
|
] as const satisfies ReadonlyArray<ContactSortField>;
|
|
386
387
|
|
|
388
|
+
export const CONTACT_STATUS_TAG_TYPE = {
|
|
389
|
+
VERIFICATION_REQUIRED: "VERIFICATION_REQUIRED",
|
|
390
|
+
} as const satisfies Record<string, ContactStatusTagType>;
|
|
391
|
+
|
|
392
|
+
export const CONTACT_STATUS_TAG_TYPE_VALUES = [
|
|
393
|
+
'VERIFICATION_REQUIRED',
|
|
394
|
+
] as const satisfies ReadonlyArray<ContactStatusTagType>;
|
|
395
|
+
|
|
387
396
|
export const CONTACT_TYPE = {
|
|
388
397
|
OWNER: "owner",
|
|
389
398
|
AGENT: "agent",
|
package/src/helpers/keys.ts
CHANGED
|
@@ -60,6 +60,7 @@ import type {
|
|
|
60
60
|
ContactCreateWorkerResult,
|
|
61
61
|
ContactHandle,
|
|
62
62
|
Contact,
|
|
63
|
+
ContactStatusTag,
|
|
63
64
|
ContactVerificationApi,
|
|
64
65
|
ContactVerificationEidInformation,
|
|
65
66
|
ContactVerificationEmail,
|
|
@@ -1332,6 +1333,18 @@ export const KEYS_CONTACT = [
|
|
|
1332
1333
|
KEY_CONTACT_TITLE,
|
|
1333
1334
|
] as const satisfies (keyof Contact)[];
|
|
1334
1335
|
|
|
1336
|
+
export const KEY_CONTACT_STATUS_TAG_COLOR = 'color' satisfies keyof ContactStatusTag;
|
|
1337
|
+
export const KEY_CONTACT_STATUS_TAG_DESCRIPTION = 'description' satisfies keyof ContactStatusTag;
|
|
1338
|
+
export const KEY_CONTACT_STATUS_TAG_LABEL = 'label' satisfies keyof ContactStatusTag;
|
|
1339
|
+
export const KEY_CONTACT_STATUS_TAG_TAG_TYPE = 'tag_type' satisfies keyof ContactStatusTag;
|
|
1340
|
+
|
|
1341
|
+
export const KEYS_CONTACT_STATUS_TAG = [
|
|
1342
|
+
KEY_CONTACT_STATUS_TAG_COLOR,
|
|
1343
|
+
KEY_CONTACT_STATUS_TAG_DESCRIPTION,
|
|
1344
|
+
KEY_CONTACT_STATUS_TAG_LABEL,
|
|
1345
|
+
KEY_CONTACT_STATUS_TAG_TAG_TYPE,
|
|
1346
|
+
] as const satisfies (keyof ContactStatusTag)[];
|
|
1347
|
+
|
|
1335
1348
|
export const KEY_CONTACT_VERIFICATION_API_CANCELED_ON = 'canceled_on' satisfies keyof ContactVerificationApi;
|
|
1336
1349
|
export const KEY_CONTACT_VERIFICATION_API_CONTACT_ID = 'contact_id' satisfies keyof ContactVerificationApi;
|
|
1337
1350
|
export const KEY_CONTACT_VERIFICATION_API_CONTACT_VERIFICATION_ID = 'contact_verification_id' satisfies keyof ContactVerificationApi;
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -80,6 +80,8 @@ export type ContactIdList = components['schemas']['ContactIdList'];
|
|
|
80
80
|
export type ContactIncludeField = components['schemas']['ContactIncludeField'];
|
|
81
81
|
export type Contact = components['schemas']['ContactResponse'];
|
|
82
82
|
export type ContactSortField = components['schemas']['ContactSortField'];
|
|
83
|
+
export type ContactStatusTag = components['schemas']['ContactStatusTagResponse'];
|
|
84
|
+
export type ContactStatusTagType = components['schemas']['ContactStatusTagType'];
|
|
83
85
|
export type ContactType = components['schemas']['ContactType'];
|
|
84
86
|
export type ContactVerificationApi = components['schemas']['ContactVerificationApiResponse'];
|
|
85
87
|
export type ContactVerificationClaim = components['schemas']['ContactVerificationClaim'];
|
package/src/openapi.yaml
CHANGED
|
@@ -9327,7 +9327,7 @@ components:
|
|
|
9327
9327
|
status_tags:
|
|
9328
9328
|
anyOf:
|
|
9329
9329
|
- items:
|
|
9330
|
-
$ref: '#/components/schemas/
|
|
9330
|
+
$ref: '#/components/schemas/ContactStatusTagResponse'
|
|
9331
9331
|
type: array
|
|
9332
9332
|
- type: 'null'
|
|
9333
9333
|
description: Status tags assigned to this contact. Only included when ?include=tags
|
|
@@ -9375,6 +9375,37 @@ components:
|
|
|
9375
9375
|
- created_on
|
|
9376
9376
|
title: ContactSortField
|
|
9377
9377
|
type: string
|
|
9378
|
+
ContactStatusTagResponse:
|
|
9379
|
+
properties:
|
|
9380
|
+
color:
|
|
9381
|
+
$ref: '#/components/schemas/TagColor'
|
|
9382
|
+
description: The color of the tag
|
|
9383
|
+
description:
|
|
9384
|
+
anyOf:
|
|
9385
|
+
- type: string
|
|
9386
|
+
- type: 'null'
|
|
9387
|
+
description: Additional information about this status tag
|
|
9388
|
+
title: Description
|
|
9389
|
+
label:
|
|
9390
|
+
description: The label of the tag
|
|
9391
|
+
maxLength: 255
|
|
9392
|
+
minLength: 1
|
|
9393
|
+
title: Label
|
|
9394
|
+
type: string
|
|
9395
|
+
tag_type:
|
|
9396
|
+
$ref: '#/components/schemas/ContactStatusTagType'
|
|
9397
|
+
description: The status tag type identifier
|
|
9398
|
+
required:
|
|
9399
|
+
- tag_type
|
|
9400
|
+
- label
|
|
9401
|
+
- color
|
|
9402
|
+
title: ContactStatusTagResponse
|
|
9403
|
+
type: object
|
|
9404
|
+
ContactStatusTagType:
|
|
9405
|
+
enum:
|
|
9406
|
+
- VERIFICATION_REQUIRED
|
|
9407
|
+
title: ContactStatusTagType
|
|
9408
|
+
type: string
|
|
9378
9409
|
ContactType:
|
|
9379
9410
|
enum:
|
|
9380
9411
|
- owner
|
|
@@ -24969,7 +25000,7 @@ info:
|
|
|
24969
25000
|
\n\n"
|
|
24970
25001
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
24971
25002
|
title: OpusDNS API
|
|
24972
|
-
version: 2026-10-01-
|
|
25003
|
+
version: 2026-10-01-130224
|
|
24973
25004
|
x-logo:
|
|
24974
25005
|
altText: OpusDNS API Reference
|
|
24975
25006
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -27252,17 +27283,19 @@ paths:
|
|
|
27252
27283
|
schema:
|
|
27253
27284
|
$ref: '#/components/schemas/SortOrder'
|
|
27254
27285
|
default: desc
|
|
27255
|
-
- description: Filter by status tag types. Can be specified multiple
|
|
27286
|
+
- description: Filter by contact status tag types. Can be specified multiple
|
|
27287
|
+
times.
|
|
27256
27288
|
in: query
|
|
27257
27289
|
name: status_tags
|
|
27258
27290
|
required: false
|
|
27259
27291
|
schema:
|
|
27260
27292
|
anyOf:
|
|
27261
27293
|
- items:
|
|
27262
|
-
$ref: '#/components/schemas/
|
|
27294
|
+
$ref: '#/components/schemas/ContactStatusTagType'
|
|
27263
27295
|
type: array
|
|
27264
27296
|
- type: 'null'
|
|
27265
|
-
description: Filter by status tag types. Can be specified multiple
|
|
27297
|
+
description: Filter by contact status tag types. Can be specified multiple
|
|
27298
|
+
times.
|
|
27266
27299
|
title: Status Tags
|
|
27267
27300
|
- in: query
|
|
27268
27301
|
name: status_tag_mode
|
package/src/schema.d.ts
CHANGED
|
@@ -10151,7 +10151,7 @@ export interface components {
|
|
|
10151
10151
|
* Status Tags
|
|
10152
10152
|
* @description Status tags assigned to this contact. Only included when ?include=tags is specified.
|
|
10153
10153
|
*/
|
|
10154
|
-
status_tags?: components["schemas"]["
|
|
10154
|
+
status_tags?: components["schemas"]["ContactStatusTagResponse"][] | null;
|
|
10155
10155
|
/**
|
|
10156
10156
|
* Street
|
|
10157
10157
|
* @description The address of the contact
|
|
@@ -10173,6 +10173,28 @@ export interface components {
|
|
|
10173
10173
|
* @enum {string}
|
|
10174
10174
|
*/
|
|
10175
10175
|
ContactSortField: "first_name" | "last_name" | "email" | "created_on";
|
|
10176
|
+
/** ContactStatusTagResponse */
|
|
10177
|
+
ContactStatusTagResponse: {
|
|
10178
|
+
/** @description The color of the tag */
|
|
10179
|
+
color: components["schemas"]["TagColor"];
|
|
10180
|
+
/**
|
|
10181
|
+
* Description
|
|
10182
|
+
* @description Additional information about this status tag
|
|
10183
|
+
*/
|
|
10184
|
+
description?: string | null;
|
|
10185
|
+
/**
|
|
10186
|
+
* Label
|
|
10187
|
+
* @description The label of the tag
|
|
10188
|
+
*/
|
|
10189
|
+
label: string;
|
|
10190
|
+
/** @description The status tag type identifier */
|
|
10191
|
+
tag_type: components["schemas"]["ContactStatusTagType"];
|
|
10192
|
+
};
|
|
10193
|
+
/**
|
|
10194
|
+
* ContactStatusTagType
|
|
10195
|
+
* @enum {string}
|
|
10196
|
+
*/
|
|
10197
|
+
ContactStatusTagType: "VERIFICATION_REQUIRED";
|
|
10176
10198
|
/**
|
|
10177
10199
|
* ContactType
|
|
10178
10200
|
* @enum {string}
|
|
@@ -22411,8 +22433,8 @@ export interface operations {
|
|
|
22411
22433
|
page_size?: number;
|
|
22412
22434
|
sort_by?: components["schemas"]["ContactSortField"];
|
|
22413
22435
|
sort_order?: components["schemas"]["SortOrder"];
|
|
22414
|
-
/** @description Filter by status tag types. Can be specified multiple times. */
|
|
22415
|
-
status_tags?: components["schemas"]["
|
|
22436
|
+
/** @description Filter by contact status tag types. Can be specified multiple times. */
|
|
22437
|
+
status_tags?: components["schemas"]["ContactStatusTagType"][] | null;
|
|
22416
22438
|
status_tag_mode?: components["schemas"]["TagFilterMode"];
|
|
22417
22439
|
/** @description Filter by user tag IDs. Can be specified multiple times. */
|
|
22418
22440
|
tag_ids?: TypeId<"tag">[] | null;
|