@opusdns/api 1.62.0 → 1.64.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 +2 -0
- package/src/helpers/keys.ts +4 -0
- package/src/openapi.yaml +36 -19
- package/src/schema.d.ts +15 -3
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -481,6 +481,7 @@ export const DNS_PROTECTED_REASON = {
|
|
|
481
481
|
SYSTEM_MANAGED_NS: "SYSTEM_MANAGED_NS",
|
|
482
482
|
EMAIL_FORWARD: "EMAIL_FORWARD",
|
|
483
483
|
DOMAIN_FORWARD: "DOMAIN_FORWARD",
|
|
484
|
+
WHITELABEL: "WHITELABEL",
|
|
484
485
|
GENERIC: "GENERIC",
|
|
485
486
|
} as const satisfies Record<string, DnsProtectedReason>;
|
|
486
487
|
|
|
@@ -489,6 +490,7 @@ export const DNS_PROTECTED_REASON_VALUES = [
|
|
|
489
490
|
'SYSTEM_MANAGED_NS',
|
|
490
491
|
'EMAIL_FORWARD',
|
|
491
492
|
'DOMAIN_FORWARD',
|
|
493
|
+
'WHITELABEL',
|
|
492
494
|
'GENERIC',
|
|
493
495
|
] as const satisfies ReadonlyArray<DnsProtectedReason>;
|
|
494
496
|
|
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
|
@@ -2359,6 +2359,7 @@ components:
|
|
|
2359
2359
|
- SYSTEM_MANAGED_NS
|
|
2360
2360
|
- EMAIL_FORWARD
|
|
2361
2361
|
- DOMAIN_FORWARD
|
|
2362
|
+
- WHITELABEL
|
|
2362
2363
|
- GENERIC
|
|
2363
2364
|
title: DnsProtectedReason
|
|
2364
2365
|
type: string
|
|
@@ -8054,8 +8055,19 @@ components:
|
|
|
8054
8055
|
title: Batch Id
|
|
8055
8056
|
type: string
|
|
8056
8057
|
x-typeid-prefix: batch
|
|
8058
|
+
blocked_count:
|
|
8059
|
+
default: 0
|
|
8060
|
+
description: Number of retried jobs held behind the topic rate limit or
|
|
8061
|
+
backlog (BLOCKED)
|
|
8062
|
+
title: Blocked Count
|
|
8063
|
+
type: integer
|
|
8064
|
+
queued_count:
|
|
8065
|
+
default: 0
|
|
8066
|
+
description: Number of retried jobs dispatched immediately (QUEUED)
|
|
8067
|
+
title: Queued Count
|
|
8068
|
+
type: integer
|
|
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
|
title: Retried Count
|
|
8060
8072
|
type: integer
|
|
8061
8073
|
required:
|
|
@@ -8341,8 +8353,8 @@ components:
|
|
|
8341
8353
|
title: Started At
|
|
8342
8354
|
status:
|
|
8343
8355
|
$ref: '#/components/schemas/JobStatus'
|
|
8344
|
-
description: 'Current job status:
|
|
8345
|
-
or dead_letter'
|
|
8356
|
+
description: 'Current job status: blocked, queued, paused, running, succeeded,
|
|
8357
|
+
failed, canceled, or dead_letter'
|
|
8346
8358
|
required:
|
|
8347
8359
|
- job_id
|
|
8348
8360
|
- status
|
|
@@ -13869,7 +13881,7 @@ info:
|
|
|
13869
13881
|
\n\n"
|
|
13870
13882
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
13871
13883
|
title: OpusDNS API
|
|
13872
|
-
version: 2026-07-
|
|
13884
|
+
version: 2026-07-17-134537
|
|
13873
13885
|
x-logo:
|
|
13874
13886
|
altText: OpusDNS API Reference
|
|
13875
13887
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -29772,21 +29784,26 @@ tags:
|
|
|
29772
29784
|
\ (single) or is silently skipped (batch)\n- `queued`, `blocked`, `paused`, `running`\
|
|
29773
29785
|
\ \u2014 still in progress; not touched\n\nCalling batch retry on a mixed-state\
|
|
29774
29786
|
\ batch returns `retried_count` (the number of `failed` / `dead_letter` jobs that\
|
|
29775
|
-
\ were
|
|
29776
|
-
\ jobs, `retried_count` is `0
|
|
29777
|
-
\
|
|
29778
|
-
\
|
|
29779
|
-
\
|
|
29780
|
-
\ `
|
|
29781
|
-
\
|
|
29782
|
-
\
|
|
29783
|
-
\
|
|
29784
|
-
\
|
|
29785
|
-
\
|
|
29786
|
-
\
|
|
29787
|
-
\
|
|
29788
|
-
\
|
|
29789
|
-
\
|
|
29787
|
+
\ were reset for retry); everything else is left alone. If the batch has no retryable\
|
|
29788
|
+
\ jobs, `retried_count` is `0`. The response also splits that total into `queued_count`\
|
|
29789
|
+
\ (jobs dispatched immediately) and `blocked_count` (jobs held behind the topic's\
|
|
29790
|
+
\ rate limit or backlog \u2014 these are released automatically as capacity frees\
|
|
29791
|
+
\ up).\n\n#### What happens to a retried job\n\nEach retried job is reset to a\
|
|
29792
|
+
\ fresh attempt:\n\n- `status` \u2192 `queued`, or `blocked` if the job's topic\
|
|
29793
|
+
\ is rate-limited and has no capacity (or a higher-priority backlog is waiting)\
|
|
29794
|
+
\ \u2014 a blocked job is released to `queued` automatically as capacity frees\
|
|
29795
|
+
\ up\n- `attempts` \u2192 `0`\n- `not_before` \u2192 now\n- `error_class` and\
|
|
29796
|
+
\ `error_message` \u2192 cleared\n- The job is republished for worker pickup once\
|
|
29797
|
+
\ it is `queued`\n\nThe original `payload`, `idempotency_key`, `correlation_id`\
|
|
29798
|
+
\ (batch id), `max_attempts`, and backoff configuration are preserved. Each retry\
|
|
29799
|
+
\ is processed under the same worker idempotency guarantees as the original \u2014\
|
|
29800
|
+
\ for billing operations specifically, a retried job will not double-charge an\
|
|
29801
|
+
\ account that was already debited.\n\n#### Filtering by error type\n\nA batch\
|
|
29802
|
+
\ may contain a mix of failures that you do and don't want to retry. For example,\
|
|
29803
|
+
\ after adding funds to your account, you may want to retry only the jobs that\
|
|
29804
|
+
\ failed with `BillingInsufficientFundsError`, while leaving alone jobs that failed\
|
|
29805
|
+
\ for other reasons (e.g. an invalid domain name that should not be re-attempted).\n\
|
|
29806
|
+
\nPass one or more `error_class` query parameters to filter:\n\n```\nPOST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError\n\
|
|
29790
29807
|
POST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError&error_class=DomainRegistryTemporaryError\n\
|
|
29791
29808
|
```\n\nMultiple values are OR'd \u2014 a job is retried if its `error_class` matches\
|
|
29792
29809
|
\ **any** of the supplied values. Omitting the filter retries all `failed` and\
|
package/src/schema.d.ts
CHANGED
|
@@ -4312,7 +4312,7 @@ export interface components {
|
|
|
4312
4312
|
* DnsProtectedReason
|
|
4313
4313
|
* @enum {string}
|
|
4314
4314
|
*/
|
|
4315
|
-
DnsProtectedReason: "SYSTEM_MANAGED_SOA" | "SYSTEM_MANAGED_NS" | "EMAIL_FORWARD" | "DOMAIN_FORWARD" | "GENERIC";
|
|
4315
|
+
DnsProtectedReason: "SYSTEM_MANAGED_SOA" | "SYSTEM_MANAGED_NS" | "EMAIL_FORWARD" | "DOMAIN_FORWARD" | "WHITELABEL" | "GENERIC";
|
|
4316
4316
|
/** DnsRecordCreate */
|
|
4317
4317
|
DnsRecordCreate: {
|
|
4318
4318
|
/** Rdata */
|
|
@@ -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
|
/**
|