@opusdns/api 1.63.0 → 1.65.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 +12 -0
- package/src/helpers/keys.ts +4 -0
- package/src/openapi.yaml +41 -19
- package/src/schema.d.ts +16 -4
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -608,6 +608,9 @@ export const DOMAIN_ATTRIBUTE_KEY = {
|
|
|
608
608
|
VERIFICATION_REQUIRED: "verification_required",
|
|
609
609
|
DE_GENERAL_REQUEST_CONTACT: "de_general_request_contact",
|
|
610
610
|
DE_ABUSE_CONTACT: "de_abuse_contact",
|
|
611
|
+
NOR_ID_APPLICANT_VERSION: "nor_id_applicant_version",
|
|
612
|
+
NOR_ID_APPLICANT_ACCEPT_NAME: "nor_id_applicant_accept_name",
|
|
613
|
+
NOR_ID_APPLICANT_ACCEPT_DATE: "nor_id_applicant_accept_date",
|
|
611
614
|
} as const satisfies Record<string, DomainAttributeKey>;
|
|
612
615
|
|
|
613
616
|
export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
|
|
@@ -618,6 +621,9 @@ export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
|
|
|
618
621
|
'verification_required',
|
|
619
622
|
'de_general_request_contact',
|
|
620
623
|
'de_abuse_contact',
|
|
624
|
+
'nor_id_applicant_version',
|
|
625
|
+
'nor_id_applicant_accept_name',
|
|
626
|
+
'nor_id_applicant_accept_date',
|
|
621
627
|
] as const satisfies ReadonlyArray<DomainAttributeKey>;
|
|
622
628
|
|
|
623
629
|
export const DOMAIN_AVAILABILITY_STATUS = {
|
|
@@ -1514,6 +1520,9 @@ export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
|
|
|
1514
1520
|
NIC_LV_VAT_NR: "NIC_LV_VAT_NR",
|
|
1515
1521
|
DOMREG_LT_CONTACT_ROLE: "DOMREG_LT_CONTACT_ROLE",
|
|
1516
1522
|
DOMREG_LT_ORG_CODE: "DOMREG_LT_ORG_CODE",
|
|
1523
|
+
NOR_ID_CONTACT_TYPE: "NOR_ID_CONTACT_TYPE",
|
|
1524
|
+
NOR_ID_IDENTITY_TYPE: "NOR_ID_IDENTITY_TYPE",
|
|
1525
|
+
NOR_ID_IDENTITY_VALUE: "NOR_ID_IDENTITY_VALUE",
|
|
1517
1526
|
} as const satisfies Record<string, RegistryHandleAttributeType>;
|
|
1518
1527
|
|
|
1519
1528
|
export const REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES = [
|
|
@@ -1567,6 +1576,9 @@ export const REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES = [
|
|
|
1567
1576
|
'NIC_LV_VAT_NR',
|
|
1568
1577
|
'DOMREG_LT_CONTACT_ROLE',
|
|
1569
1578
|
'DOMREG_LT_ORG_CODE',
|
|
1579
|
+
'NOR_ID_CONTACT_TYPE',
|
|
1580
|
+
'NOR_ID_IDENTITY_TYPE',
|
|
1581
|
+
'NOR_ID_IDENTITY_VALUE',
|
|
1570
1582
|
] as const satisfies ReadonlyArray<RegistryHandleAttributeType>;
|
|
1571
1583
|
|
|
1572
1584
|
export const RENEWAL_MODE = {
|
package/src/helpers/keys.ts
CHANGED
|
@@ -3491,10 +3491,14 @@ export const KEYS_JOB_BATCH_REQUEST = [
|
|
|
3491
3491
|
] as const satisfies (keyof JobBatchRequest)[];
|
|
3492
3492
|
|
|
3493
3493
|
export const KEY_JOB_BATCH_RETRY_BATCH_ID = 'batch_id' satisfies keyof JobBatchRetry;
|
|
3494
|
+
export const KEY_JOB_BATCH_RETRY_BLOCKED_COUNT = 'blocked_count' satisfies keyof JobBatchRetry;
|
|
3495
|
+
export const KEY_JOB_BATCH_RETRY_QUEUED_COUNT = 'queued_count' satisfies keyof JobBatchRetry;
|
|
3494
3496
|
export const KEY_JOB_BATCH_RETRY_RETRIED_COUNT = 'retried_count' satisfies keyof JobBatchRetry;
|
|
3495
3497
|
|
|
3496
3498
|
export const KEYS_JOB_BATCH_RETRY = [
|
|
3497
3499
|
KEY_JOB_BATCH_RETRY_BATCH_ID,
|
|
3500
|
+
KEY_JOB_BATCH_RETRY_BLOCKED_COUNT,
|
|
3501
|
+
KEY_JOB_BATCH_RETRY_QUEUED_COUNT,
|
|
3498
3502
|
KEY_JOB_BATCH_RETRY_RETRIED_COUNT,
|
|
3499
3503
|
] as const satisfies (keyof JobBatchRetry)[];
|
|
3500
3504
|
|
package/src/openapi.yaml
CHANGED
|
@@ -3397,6 +3397,9 @@ components:
|
|
|
3397
3397
|
- verification_required
|
|
3398
3398
|
- de_general_request_contact
|
|
3399
3399
|
- de_abuse_contact
|
|
3400
|
+
- nor_id_applicant_version
|
|
3401
|
+
- nor_id_applicant_accept_name
|
|
3402
|
+
- nor_id_applicant_accept_date
|
|
3400
3403
|
title: DomainAttributeKey
|
|
3401
3404
|
type: string
|
|
3402
3405
|
DomainAvailability:
|
|
@@ -8055,8 +8058,19 @@ components:
|
|
|
8055
8058
|
title: Batch Id
|
|
8056
8059
|
type: string
|
|
8057
8060
|
x-typeid-prefix: batch
|
|
8061
|
+
blocked_count:
|
|
8062
|
+
default: 0
|
|
8063
|
+
description: Number of retried jobs held behind the topic rate limit or
|
|
8064
|
+
backlog (BLOCKED)
|
|
8065
|
+
title: Blocked Count
|
|
8066
|
+
type: integer
|
|
8067
|
+
queued_count:
|
|
8068
|
+
default: 0
|
|
8069
|
+
description: Number of retried jobs dispatched immediately (QUEUED)
|
|
8070
|
+
title: Queued Count
|
|
8071
|
+
type: integer
|
|
8058
8072
|
retried_count:
|
|
8059
|
-
description: Number of FAILED/DEAD_LETTER jobs reset
|
|
8073
|
+
description: Number of FAILED/DEAD_LETTER jobs reset for retry
|
|
8060
8074
|
title: Retried Count
|
|
8061
8075
|
type: integer
|
|
8062
8076
|
required:
|
|
@@ -8342,8 +8356,8 @@ components:
|
|
|
8342
8356
|
title: Started At
|
|
8343
8357
|
status:
|
|
8344
8358
|
$ref: '#/components/schemas/JobStatus'
|
|
8345
|
-
description: 'Current job status:
|
|
8346
|
-
or dead_letter'
|
|
8359
|
+
description: 'Current job status: blocked, queued, paused, running, succeeded,
|
|
8360
|
+
failed, canceled, or dead_letter'
|
|
8347
8361
|
required:
|
|
8348
8362
|
- job_id
|
|
8349
8363
|
- status
|
|
@@ -11389,6 +11403,9 @@ components:
|
|
|
11389
11403
|
- NIC_LV_VAT_NR
|
|
11390
11404
|
- DOMREG_LT_CONTACT_ROLE
|
|
11391
11405
|
- DOMREG_LT_ORG_CODE
|
|
11406
|
+
- NOR_ID_CONTACT_TYPE
|
|
11407
|
+
- NOR_ID_IDENTITY_TYPE
|
|
11408
|
+
- NOR_ID_IDENTITY_VALUE
|
|
11392
11409
|
title: RegistryHandleAttributeType
|
|
11393
11410
|
type: string
|
|
11394
11411
|
RegistryLockBase:
|
|
@@ -13870,7 +13887,7 @@ info:
|
|
|
13870
13887
|
\n\n"
|
|
13871
13888
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
13872
13889
|
title: OpusDNS API
|
|
13873
|
-
version: 2026-07-17-
|
|
13890
|
+
version: 2026-07-17-145127
|
|
13874
13891
|
x-logo:
|
|
13875
13892
|
altText: OpusDNS API Reference
|
|
13876
13893
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -29773,21 +29790,26 @@ tags:
|
|
|
29773
29790
|
\ (single) or is silently skipped (batch)\n- `queued`, `blocked`, `paused`, `running`\
|
|
29774
29791
|
\ \u2014 still in progress; not touched\n\nCalling batch retry on a mixed-state\
|
|
29775
29792
|
\ batch returns `retried_count` (the number of `failed` / `dead_letter` jobs that\
|
|
29776
|
-
\ were
|
|
29777
|
-
\ jobs, `retried_count` is `0
|
|
29778
|
-
\
|
|
29779
|
-
\
|
|
29780
|
-
\
|
|
29781
|
-
\ `
|
|
29782
|
-
\
|
|
29783
|
-
\
|
|
29784
|
-
\
|
|
29785
|
-
\
|
|
29786
|
-
\
|
|
29787
|
-
\
|
|
29788
|
-
\
|
|
29789
|
-
\
|
|
29790
|
-
\
|
|
29793
|
+
\ were reset for retry); everything else is left alone. If the batch has no retryable\
|
|
29794
|
+
\ jobs, `retried_count` is `0`. The response also splits that total into `queued_count`\
|
|
29795
|
+
\ (jobs dispatched immediately) and `blocked_count` (jobs held behind the topic's\
|
|
29796
|
+
\ rate limit or backlog \u2014 these are released automatically as capacity frees\
|
|
29797
|
+
\ up).\n\n#### What happens to a retried job\n\nEach retried job is reset to a\
|
|
29798
|
+
\ fresh attempt:\n\n- `status` \u2192 `queued`, or `blocked` if the job's topic\
|
|
29799
|
+
\ is rate-limited and has no capacity (or a higher-priority backlog is waiting)\
|
|
29800
|
+
\ \u2014 a blocked job is released to `queued` automatically as capacity frees\
|
|
29801
|
+
\ up\n- `attempts` \u2192 `0`\n- `not_before` \u2192 now\n- `error_class` and\
|
|
29802
|
+
\ `error_message` \u2192 cleared\n- The job is republished for worker pickup once\
|
|
29803
|
+
\ it is `queued`\n\nThe original `payload`, `idempotency_key`, `correlation_id`\
|
|
29804
|
+
\ (batch id), `max_attempts`, and backoff configuration are preserved. Each retry\
|
|
29805
|
+
\ is processed under the same worker idempotency guarantees as the original \u2014\
|
|
29806
|
+
\ for billing operations specifically, a retried job will not double-charge an\
|
|
29807
|
+
\ account that was already debited.\n\n#### Filtering by error type\n\nA batch\
|
|
29808
|
+
\ may contain a mix of failures that you do and don't want to retry. For example,\
|
|
29809
|
+
\ after adding funds to your account, you may want to retry only the jobs that\
|
|
29810
|
+
\ failed with `BillingInsufficientFundsError`, while leaving alone jobs that failed\
|
|
29811
|
+
\ for other reasons (e.g. an invalid domain name that should not be re-attempted).\n\
|
|
29812
|
+
\nPass one or more `error_class` query parameters to filter:\n\n```\nPOST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError\n\
|
|
29791
29813
|
POST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError&error_class=DomainRegistryTemporaryError\n\
|
|
29792
29814
|
```\n\nMultiple values are OR'd \u2014 a job is retried if its `error_class` matches\
|
|
29793
29815
|
\ **any** of the supplied values. Omitting the filter retries all `failed` and\
|
package/src/schema.d.ts
CHANGED
|
@@ -4945,7 +4945,7 @@ export interface components {
|
|
|
4945
4945
|
* DomainAttributeKey
|
|
4946
4946
|
* @enum {string}
|
|
4947
4947
|
*/
|
|
4948
|
-
DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "nic_it_compliance_confirmation" | "travel_industry_acknowledgement" | "verification_required" | "de_general_request_contact" | "de_abuse_contact";
|
|
4948
|
+
DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "nic_it_compliance_confirmation" | "travel_industry_acknowledgement" | "verification_required" | "de_general_request_contact" | "de_abuse_contact" | "nor_id_applicant_version" | "nor_id_applicant_accept_name" | "nor_id_applicant_accept_date";
|
|
4949
4949
|
/** DomainAvailability */
|
|
4950
4950
|
DomainAvailability: {
|
|
4951
4951
|
/** Domain */
|
|
@@ -8053,9 +8053,21 @@ export interface components {
|
|
|
8053
8053
|
* @example batch_01h45ytscbebyvny4gc8cr8ma2
|
|
8054
8054
|
*/
|
|
8055
8055
|
batch_id: TypeId<"batch">;
|
|
8056
|
+
/**
|
|
8057
|
+
* Blocked Count
|
|
8058
|
+
* @description Number of retried jobs held behind the topic rate limit or backlog (BLOCKED)
|
|
8059
|
+
* @default 0
|
|
8060
|
+
*/
|
|
8061
|
+
blocked_count: number;
|
|
8062
|
+
/**
|
|
8063
|
+
* Queued Count
|
|
8064
|
+
* @description Number of retried jobs dispatched immediately (QUEUED)
|
|
8065
|
+
* @default 0
|
|
8066
|
+
*/
|
|
8067
|
+
queued_count: number;
|
|
8056
8068
|
/**
|
|
8057
8069
|
* Retried Count
|
|
8058
|
-
* @description Number of FAILED/DEAD_LETTER jobs reset
|
|
8070
|
+
* @description Number of FAILED/DEAD_LETTER jobs reset for retry
|
|
8059
8071
|
*/
|
|
8060
8072
|
retried_count: number;
|
|
8061
8073
|
};
|
|
@@ -8265,7 +8277,7 @@ export interface components {
|
|
|
8265
8277
|
* @description Timestamp when job execution began (UTC)
|
|
8266
8278
|
*/
|
|
8267
8279
|
started_at?: Date | null;
|
|
8268
|
-
/** @description Current job status: queued, running, succeeded, failed, canceled, or dead_letter */
|
|
8280
|
+
/** @description Current job status: blocked, queued, paused, running, succeeded, failed, canceled, or dead_letter */
|
|
8269
8281
|
status: components["schemas"]["JobStatus"];
|
|
8270
8282
|
};
|
|
8271
8283
|
/**
|
|
@@ -10204,7 +10216,7 @@ export interface components {
|
|
|
10204
10216
|
* @description Registry handle attribute types for type-safe attribute key access.
|
|
10205
10217
|
* @enum {string}
|
|
10206
10218
|
*/
|
|
10207
|
-
RegistryHandleAttributeType: "at-ext-contact:type" | "DE_CONTACT_TYPE" | "DE_GENERAL_REQUEST_URI_TEMPLATE" | "DE_ABUSE_URI_TEMPLATE" | "dnsbe:type" | "eurid:type" | "AFNIC_CONTACT_TYPE" | "AFNIC_PP_FIRST_NAME" | "AFNIC_PM_LEGAL_STATUS" | "AFNIC_PM_SIREN" | "AFNIC_PM_VAT" | "AFNIC_PM_TRADEMARK" | "AFNIC_PM_ASSOC_WALDEC" | "AFNIC_PM_ASSOC_PUBL_DATE" | "AFNIC_PM_ASSOC_PUBL_ANNOUNCE" | "AFNIC_PM_ASSOC_PUBL_PAGE" | "AFNIC_PM_ASSOC_DECL" | "AFNIC_PM_DUNS" | "AFNIC_PM_LOCAL" | "AFNIC_ID_STATUS" | "AFNIC_REACHABLE_MEDIA" | "AFNIC_REACHABLE_STATUS" | "AFNIC_RESTRICTED_PUBLICATION" | "ROTLD_CONTACT_TYPE" | "ROTLD_CNP_FISCAL_CODE" | "ROTLD_ID_NUMBER" | "ROTLD_REGISTRATION_NUMBER" | "ROTLD_DOMAIN_NAME" | "NOMINET_CONTACT_TYPE" | "NOMINET_CO_NO" | "NOMINET_TRAD_NAME" | "CIRA_CPR" | "SIDN_LEGAL_FORM" | "SIDN_LEGAL_REG_NO" | "US_NEXUS_CATEGORY" | "US_NEXUS_COUNTRY_CODE" | "US_APP_PURPOSE" | "NIC_IT_ENTITY_TYPE" | "NIC_IT_REG_CODE" | "CZ_NIC_IDENT_TYPE" | "CZ_NIC_IDENT_VALUE" | "CZ_NIC_VAT" | "CZ_NIC_NOTIFY_EMAIL" | "DNS_LU_CONTACT_ROLE" | "SK_NIC_LEGAL_FORM" | "SK_NIC_IDENT_VALUE" | "NIC_LV_REG_NR" | "NIC_LV_VAT_NR" | "DOMREG_LT_CONTACT_ROLE" | "DOMREG_LT_ORG_CODE";
|
|
10219
|
+
RegistryHandleAttributeType: "at-ext-contact:type" | "DE_CONTACT_TYPE" | "DE_GENERAL_REQUEST_URI_TEMPLATE" | "DE_ABUSE_URI_TEMPLATE" | "dnsbe:type" | "eurid:type" | "AFNIC_CONTACT_TYPE" | "AFNIC_PP_FIRST_NAME" | "AFNIC_PM_LEGAL_STATUS" | "AFNIC_PM_SIREN" | "AFNIC_PM_VAT" | "AFNIC_PM_TRADEMARK" | "AFNIC_PM_ASSOC_WALDEC" | "AFNIC_PM_ASSOC_PUBL_DATE" | "AFNIC_PM_ASSOC_PUBL_ANNOUNCE" | "AFNIC_PM_ASSOC_PUBL_PAGE" | "AFNIC_PM_ASSOC_DECL" | "AFNIC_PM_DUNS" | "AFNIC_PM_LOCAL" | "AFNIC_ID_STATUS" | "AFNIC_REACHABLE_MEDIA" | "AFNIC_REACHABLE_STATUS" | "AFNIC_RESTRICTED_PUBLICATION" | "ROTLD_CONTACT_TYPE" | "ROTLD_CNP_FISCAL_CODE" | "ROTLD_ID_NUMBER" | "ROTLD_REGISTRATION_NUMBER" | "ROTLD_DOMAIN_NAME" | "NOMINET_CONTACT_TYPE" | "NOMINET_CO_NO" | "NOMINET_TRAD_NAME" | "CIRA_CPR" | "SIDN_LEGAL_FORM" | "SIDN_LEGAL_REG_NO" | "US_NEXUS_CATEGORY" | "US_NEXUS_COUNTRY_CODE" | "US_APP_PURPOSE" | "NIC_IT_ENTITY_TYPE" | "NIC_IT_REG_CODE" | "CZ_NIC_IDENT_TYPE" | "CZ_NIC_IDENT_VALUE" | "CZ_NIC_VAT" | "CZ_NIC_NOTIFY_EMAIL" | "DNS_LU_CONTACT_ROLE" | "SK_NIC_LEGAL_FORM" | "SK_NIC_IDENT_VALUE" | "NIC_LV_REG_NR" | "NIC_LV_VAT_NR" | "DOMREG_LT_CONTACT_ROLE" | "DOMREG_LT_ORG_CODE" | "NOR_ID_CONTACT_TYPE" | "NOR_ID_IDENTITY_TYPE" | "NOR_ID_IDENTITY_VALUE";
|
|
10208
10220
|
/** RegistryLockBase */
|
|
10209
10221
|
RegistryLockBase: {
|
|
10210
10222
|
/**
|