@opusdns/api 0.299.0 → 0.301.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 +5 -1
- package/src/helpers/keys.ts +79 -0
- package/src/helpers/requests.d.ts +96 -0
- package/src/helpers/responses.d.ts +178 -1
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +203 -20
- package/src/schema.d.ts +168 -2
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -2124,6 +2124,7 @@ export const EVENT_OBJECT_TYPE = {
|
|
|
2124
2124
|
DOMAIN: "DOMAIN",
|
|
2125
2125
|
CONTACT: "CONTACT",
|
|
2126
2126
|
HOST: "HOST",
|
|
2127
|
+
ACCOUNT: "ACCOUNT",
|
|
2127
2128
|
RAW: "RAW",
|
|
2128
2129
|
UNKNOWN: "UNKNOWN",
|
|
2129
2130
|
} as const satisfies Record<string, EventObjectType>;
|
|
@@ -2153,6 +2154,7 @@ export const EVENT_OBJECT_TYPE_VALUES = [
|
|
|
2153
2154
|
'DOMAIN',
|
|
2154
2155
|
'CONTACT',
|
|
2155
2156
|
'HOST',
|
|
2157
|
+
'ACCOUNT',
|
|
2156
2158
|
'RAW',
|
|
2157
2159
|
'UNKNOWN'
|
|
2158
2160
|
] as const satisfies [string, ...string[]] | EventObjectType[];
|
|
@@ -2290,6 +2292,7 @@ export const EVENT_TYPE = {
|
|
|
2290
2292
|
TRANSIT: "TRANSIT",
|
|
2291
2293
|
WITHDRAW: "WITHDRAW",
|
|
2292
2294
|
VERIFICATION: "VERIFICATION",
|
|
2295
|
+
BALANCE: "BALANCE",
|
|
2293
2296
|
} as const satisfies Record<string, EventType>;
|
|
2294
2297
|
|
|
2295
2298
|
/**
|
|
@@ -2322,7 +2325,8 @@ export const EVENT_TYPE_VALUES = [
|
|
|
2322
2325
|
'OUTBOUND_TRANSFER',
|
|
2323
2326
|
'TRANSIT',
|
|
2324
2327
|
'WITHDRAW',
|
|
2325
|
-
'VERIFICATION'
|
|
2328
|
+
'VERIFICATION',
|
|
2329
|
+
'BALANCE'
|
|
2326
2330
|
] as const satisfies [string, ...string[]] | EventType[];
|
|
2327
2331
|
|
|
2328
2332
|
/**
|
package/src/helpers/keys.ts
CHANGED
|
@@ -219,6 +219,7 @@ import { IpRestriction } from './schemas';
|
|
|
219
219
|
import { IpRestrictionUpdate } from './schemas';
|
|
220
220
|
import { JobBatchMetadata } from './schemas';
|
|
221
221
|
import { JobBatchRequest } from './schemas';
|
|
222
|
+
import { JobBatchRetry } from './schemas';
|
|
222
223
|
import { JobBatchStatus } from './schemas';
|
|
223
224
|
import { JobCountsByStatus } from './schemas';
|
|
224
225
|
import { Job } from './schemas';
|
|
@@ -26648,6 +26649,84 @@ export const KEYS_JOB_BATCH_REQUEST = [
|
|
|
26648
26649
|
KEY_JOB_BATCH_REQUEST_PAUSED,
|
|
26649
26650
|
] as const satisfies (keyof JobBatchRequest)[];
|
|
26650
26651
|
|
|
26652
|
+
/**
|
|
26653
|
+
* Batch Id
|
|
26654
|
+
*
|
|
26655
|
+
* TypeID identifying this batch
|
|
26656
|
+
*
|
|
26657
|
+
* @type {string}
|
|
26658
|
+
*
|
|
26659
|
+
*
|
|
26660
|
+
* @remarks
|
|
26661
|
+
* This key constant provides type-safe access to the `batch_id` property of JobBatchRetry objects.
|
|
26662
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
26663
|
+
*
|
|
26664
|
+
* @example
|
|
26665
|
+
* ```typescript
|
|
26666
|
+
* // Direct property access
|
|
26667
|
+
* const value = jobbatchretry[KEY_JOB_BATCH_RETRY_BATCH_ID];
|
|
26668
|
+
*
|
|
26669
|
+
* // Dynamic property access
|
|
26670
|
+
* const propertyName = KEY_JOB_BATCH_RETRY_BATCH_ID;
|
|
26671
|
+
* const value = jobbatchretry[propertyName];
|
|
26672
|
+
* ```
|
|
26673
|
+
*
|
|
26674
|
+
* @see {@link JobBatchRetry} - The TypeScript type definition
|
|
26675
|
+
* @see {@link KEYS_JOB_BATCH_RETRY} - Array of all keys for this type
|
|
26676
|
+
*/
|
|
26677
|
+
export const KEY_JOB_BATCH_RETRY_BATCH_ID: keyof JobBatchRetry = 'batch_id';
|
|
26678
|
+
/**
|
|
26679
|
+
* Retried Count
|
|
26680
|
+
*
|
|
26681
|
+
* Number of FAILED/DEAD_LETTER jobs reset to QUEUED for retry
|
|
26682
|
+
*
|
|
26683
|
+
* @type {integer}
|
|
26684
|
+
*
|
|
26685
|
+
*
|
|
26686
|
+
* @remarks
|
|
26687
|
+
* This key constant provides type-safe access to the `retried_count` property of JobBatchRetry objects.
|
|
26688
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
26689
|
+
*
|
|
26690
|
+
* @example
|
|
26691
|
+
* ```typescript
|
|
26692
|
+
* // Direct property access
|
|
26693
|
+
* const value = jobbatchretry[KEY_JOB_BATCH_RETRY_RETRIED_COUNT];
|
|
26694
|
+
*
|
|
26695
|
+
* // Dynamic property access
|
|
26696
|
+
* const propertyName = KEY_JOB_BATCH_RETRY_RETRIED_COUNT;
|
|
26697
|
+
* const value = jobbatchretry[propertyName];
|
|
26698
|
+
* ```
|
|
26699
|
+
*
|
|
26700
|
+
* @see {@link JobBatchRetry} - The TypeScript type definition
|
|
26701
|
+
* @see {@link KEYS_JOB_BATCH_RETRY} - Array of all keys for this type
|
|
26702
|
+
*/
|
|
26703
|
+
export const KEY_JOB_BATCH_RETRY_RETRIED_COUNT: keyof JobBatchRetry = 'retried_count';
|
|
26704
|
+
|
|
26705
|
+
/**
|
|
26706
|
+
* Array of all JobBatchRetry property keys
|
|
26707
|
+
*
|
|
26708
|
+
* @remarks
|
|
26709
|
+
* This constant provides a readonly array containing all valid property keys for JobBatchRetry objects.
|
|
26710
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
26711
|
+
*
|
|
26712
|
+
* @example
|
|
26713
|
+
* ```typescript
|
|
26714
|
+
* // Iterating through all keys
|
|
26715
|
+
* for (const key of KEYS_JOB_BATCH_RETRY) {
|
|
26716
|
+
* console.log(`Property: ${key}, Value: ${jobbatchretry[key]}`);
|
|
26717
|
+
* }
|
|
26718
|
+
*
|
|
26719
|
+
* // Validation
|
|
26720
|
+
* const isValidKey = KEYS_JOB_BATCH_RETRY.includes(someKey);
|
|
26721
|
+
* ```
|
|
26722
|
+
*
|
|
26723
|
+
* @see {@link JobBatchRetry} - The TypeScript type definition
|
|
26724
|
+
*/
|
|
26725
|
+
export const KEYS_JOB_BATCH_RETRY = [
|
|
26726
|
+
KEY_JOB_BATCH_RETRY_BATCH_ID,
|
|
26727
|
+
KEY_JOB_BATCH_RETRY_RETRIED_COUNT,
|
|
26728
|
+
] as const satisfies (keyof JobBatchRetry)[];
|
|
26729
|
+
|
|
26651
26730
|
/**
|
|
26652
26731
|
* Batch Id
|
|
26653
26732
|
*
|
|
@@ -4957,6 +4957,46 @@ export type POST_JobJobIdResume_Request = {
|
|
|
4957
4957
|
*/
|
|
4958
4958
|
export type POST_JobJobIdResume_Request_Path = POST_JobJobIdResume_Request['parameters']['path'];
|
|
4959
4959
|
|
|
4960
|
+
/**
|
|
4961
|
+
* Request type for POST JobJobIdRetry endpoint
|
|
4962
|
+
*
|
|
4963
|
+
* Retry a failed or dead-lettered job
|
|
4964
|
+
*
|
|
4965
|
+
* @remarks
|
|
4966
|
+
* This type defines the complete request structure for the POST JobJobIdRetry endpoint.
|
|
4967
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
4968
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4969
|
+
*
|
|
4970
|
+
* @example
|
|
4971
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
4972
|
+
*
|
|
4973
|
+
* @path /v1/job/{job_id}/retry
|
|
4974
|
+
* @param job_id (path) - Job ID
|
|
4975
|
+
*
|
|
4976
|
+
* @see {@link POST_JobJobIdRetry_Request_Query} - Query parameters type
|
|
4977
|
+
* @see {@link POST_JobJobIdRetry_Request_Path} - Path parameters type
|
|
4978
|
+
* @see {@link POST_JobJobIdRetry_Request_Body} - Request body type
|
|
4979
|
+
*/
|
|
4980
|
+
export type POST_JobJobIdRetry_Request = {
|
|
4981
|
+
parameters: {
|
|
4982
|
+
path: operations['retry_job_v1_job__job_id__retry_post']['parameters']['path'];
|
|
4983
|
+
};
|
|
4984
|
+
}
|
|
4985
|
+
/**
|
|
4986
|
+
* Path parameters for POST /v1/job/{job_id}/retry
|
|
4987
|
+
*
|
|
4988
|
+
* @remarks
|
|
4989
|
+
* This type defines the path parameters for the POST /v1/job/{job_id}/retry endpoint.
|
|
4990
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
4991
|
+
*
|
|
4992
|
+
* @example
|
|
4993
|
+
* Use this type to ensure type safety for path parameters.
|
|
4994
|
+
*
|
|
4995
|
+
* @path /v1/job/{job_id}/retry
|
|
4996
|
+
* @param job_id (path) - Job ID
|
|
4997
|
+
*/
|
|
4998
|
+
export type POST_JobJobIdRetry_Request_Path = POST_JobJobIdRetry_Request['parameters']['path'];
|
|
4999
|
+
|
|
4960
5000
|
/**
|
|
4961
5001
|
* Request type for GET Jobs endpoint
|
|
4962
5002
|
*
|
|
@@ -5257,6 +5297,62 @@ export type POST_JobsBatchIdResume_Request = {
|
|
|
5257
5297
|
*/
|
|
5258
5298
|
export type POST_JobsBatchIdResume_Request_Path = POST_JobsBatchIdResume_Request['parameters']['path'];
|
|
5259
5299
|
|
|
5300
|
+
/**
|
|
5301
|
+
* Request type for POST JobsBatchIdRetry endpoint
|
|
5302
|
+
*
|
|
5303
|
+
* Retry failed and dead-lettered jobs in a batch
|
|
5304
|
+
*
|
|
5305
|
+
* @remarks
|
|
5306
|
+
* This type defines the complete request structure for the POST JobsBatchIdRetry endpoint.
|
|
5307
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
5308
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5309
|
+
*
|
|
5310
|
+
* @example
|
|
5311
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
5312
|
+
*
|
|
5313
|
+
* @path /v1/jobs/{batch_id}/retry
|
|
5314
|
+
* @param batch_id (path) - Batch ID
|
|
5315
|
+
* @param error_class (query) - Optional repeatable filter: only retry jobs whose error_class matches one of these values. Example: `?error_class=BillingInsufficientFundsError` to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered jobs in the batch.
|
|
5316
|
+
*
|
|
5317
|
+
* @see {@link POST_JobsBatchIdRetry_Request_Query} - Query parameters type
|
|
5318
|
+
* @see {@link POST_JobsBatchIdRetry_Request_Path} - Path parameters type
|
|
5319
|
+
* @see {@link POST_JobsBatchIdRetry_Request_Body} - Request body type
|
|
5320
|
+
*/
|
|
5321
|
+
export type POST_JobsBatchIdRetry_Request = {
|
|
5322
|
+
parameters: {
|
|
5323
|
+
query: operations['retry_batch_v1_jobs__batch_id__retry_post']['parameters']['query'];
|
|
5324
|
+
path: operations['retry_batch_v1_jobs__batch_id__retry_post']['parameters']['path'];
|
|
5325
|
+
};
|
|
5326
|
+
}
|
|
5327
|
+
/**
|
|
5328
|
+
* Query parameters for POST /v1/jobs/{batch_id}/retry
|
|
5329
|
+
*
|
|
5330
|
+
* @remarks
|
|
5331
|
+
* This type defines the query parameters for the POST /v1/jobs/{batch_id}/retry endpoint.
|
|
5332
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
5333
|
+
*
|
|
5334
|
+
* @example
|
|
5335
|
+
* Use this type to ensure type safety for query parameters.
|
|
5336
|
+
*
|
|
5337
|
+
* @path /v1/jobs/{batch_id}/retry
|
|
5338
|
+
* @param error_class (query) - Optional repeatable filter: only retry jobs whose error_class matches one of these values. Example: `?error_class=BillingInsufficientFundsError` to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered jobs in the batch.
|
|
5339
|
+
*/
|
|
5340
|
+
export type POST_JobsBatchIdRetry_Request_Query = POST_JobsBatchIdRetry_Request['parameters']['query'];
|
|
5341
|
+
/**
|
|
5342
|
+
* Path parameters for POST /v1/jobs/{batch_id}/retry
|
|
5343
|
+
*
|
|
5344
|
+
* @remarks
|
|
5345
|
+
* This type defines the path parameters for the POST /v1/jobs/{batch_id}/retry endpoint.
|
|
5346
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
5347
|
+
*
|
|
5348
|
+
* @example
|
|
5349
|
+
* Use this type to ensure type safety for path parameters.
|
|
5350
|
+
*
|
|
5351
|
+
* @path /v1/jobs/{batch_id}/retry
|
|
5352
|
+
* @param batch_id (path) - Batch ID
|
|
5353
|
+
*/
|
|
5354
|
+
export type POST_JobsBatchIdRetry_Request_Path = POST_JobsBatchIdRetry_Request['parameters']['path'];
|
|
5355
|
+
|
|
5260
5356
|
/**
|
|
5261
5357
|
* Request type for GET Organizations endpoint
|
|
5262
5358
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, ClaimsNotices, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventResponse, Job, Pagination_JobBatchMetadata, CreateJobBatch, JobBatchStatus, Pagination_Job, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, PublicReportListRes, PublicReportRes, Pagination_Tag, Tag, ObjectTagChanges2, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, ClaimsNotices, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventResponse, Job, Pagination_JobBatchMetadata, CreateJobBatch, JobBatchStatus, Pagination_Job, JobBatchRetry, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, PublicReportListRes, PublicReportRes, Pagination_Tag, Tag, ObjectTagChanges2, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AiConciergeContextsByContextId endpoint
|
|
@@ -9846,6 +9846,102 @@ export type POST_JobByJobIdResume_Response_404 = Problem
|
|
|
9846
9846
|
*/
|
|
9847
9847
|
export type POST_JobByJobIdResume_Response_422 = HTTPValidationError
|
|
9848
9848
|
|
|
9849
|
+
/**
|
|
9850
|
+
* Response types for POST JobByJobIdRetry endpoint
|
|
9851
|
+
*
|
|
9852
|
+
* Retry a failed or dead-lettered job
|
|
9853
|
+
*
|
|
9854
|
+
* @remarks
|
|
9855
|
+
* This type defines all possible response structures for the POST JobByJobIdRetry endpoint.
|
|
9856
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
9857
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
9858
|
+
*
|
|
9859
|
+
|
|
9860
|
+
*
|
|
9861
|
+
* @path /v1/job/{job_id}/retry
|
|
9862
|
+
* @param job_id (path) - Job ID
|
|
9863
|
+
*
|
|
9864
|
+
* @see {@link POST_JobByJobIdRetry_Response_200} - 200 response type
|
|
9865
|
+
* @see {@link POST_JobByJobIdRetry_Response_404} - 404 response type
|
|
9866
|
+
* @see {@link POST_JobByJobIdRetry_Response_409} - 409 response type
|
|
9867
|
+
* @see {@link POST_JobByJobIdRetry_Response_422} - 422 response type
|
|
9868
|
+
*
|
|
9869
|
+
|
|
9870
|
+
*/
|
|
9871
|
+
export type POST_JobByJobIdRetry_Response = POST_JobByJobIdRetry_Response_200 | POST_JobByJobIdRetry_Response_404 | POST_JobByJobIdRetry_Response_409 | POST_JobByJobIdRetry_Response_422;
|
|
9872
|
+
|
|
9873
|
+
/**
|
|
9874
|
+
* 200 response for POST JobByJobIdRetry endpoint
|
|
9875
|
+
*
|
|
9876
|
+
* @remarks
|
|
9877
|
+
* This type defines the response structure for the 200 status code
|
|
9878
|
+
* of the POST JobByJobIdRetry endpoint.
|
|
9879
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
9880
|
+
*
|
|
9881
|
+
|
|
9882
|
+
*
|
|
9883
|
+
* @path /v1/job/{job_id}/retry
|
|
9884
|
+
* @param job_id (path) - Job ID
|
|
9885
|
+
*
|
|
9886
|
+
* @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
|
|
9887
|
+
* @see {@link Job} - The actual schema type definition
|
|
9888
|
+
*/
|
|
9889
|
+
export type POST_JobByJobIdRetry_Response_200 = Job
|
|
9890
|
+
|
|
9891
|
+
/**
|
|
9892
|
+
* 404 response for POST JobByJobIdRetry endpoint
|
|
9893
|
+
*
|
|
9894
|
+
* @remarks
|
|
9895
|
+
* This type defines the response structure for the 404 status code
|
|
9896
|
+
* of the POST JobByJobIdRetry endpoint.
|
|
9897
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
9898
|
+
*
|
|
9899
|
+
|
|
9900
|
+
*
|
|
9901
|
+
* @path /v1/job/{job_id}/retry
|
|
9902
|
+
* @param job_id (path) - Job ID
|
|
9903
|
+
*
|
|
9904
|
+
* @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
|
|
9905
|
+
* @see {@link Problem} - The actual schema type definition
|
|
9906
|
+
*/
|
|
9907
|
+
export type POST_JobByJobIdRetry_Response_404 = Problem
|
|
9908
|
+
|
|
9909
|
+
/**
|
|
9910
|
+
* 409 response for POST JobByJobIdRetry endpoint
|
|
9911
|
+
*
|
|
9912
|
+
* @remarks
|
|
9913
|
+
* This type defines the response structure for the 409 status code
|
|
9914
|
+
* of the POST JobByJobIdRetry endpoint.
|
|
9915
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
9916
|
+
*
|
|
9917
|
+
|
|
9918
|
+
*
|
|
9919
|
+
* @path /v1/job/{job_id}/retry
|
|
9920
|
+
* @param job_id (path) - Job ID
|
|
9921
|
+
*
|
|
9922
|
+
* @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
|
|
9923
|
+
* @see {@link Problem} - The actual schema type definition
|
|
9924
|
+
*/
|
|
9925
|
+
export type POST_JobByJobIdRetry_Response_409 = Problem
|
|
9926
|
+
|
|
9927
|
+
/**
|
|
9928
|
+
* 422 response for POST JobByJobIdRetry endpoint
|
|
9929
|
+
*
|
|
9930
|
+
* @remarks
|
|
9931
|
+
* This type defines the response structure for the 422 status code
|
|
9932
|
+
* of the POST JobByJobIdRetry endpoint.
|
|
9933
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
9934
|
+
*
|
|
9935
|
+
|
|
9936
|
+
*
|
|
9937
|
+
* @path /v1/job/{job_id}/retry
|
|
9938
|
+
* @param job_id (path) - Job ID
|
|
9939
|
+
*
|
|
9940
|
+
* @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
|
|
9941
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
9942
|
+
*/
|
|
9943
|
+
export type POST_JobByJobIdRetry_Response_422 = HTTPValidationError
|
|
9944
|
+
|
|
9849
9945
|
/**
|
|
9850
9946
|
* Response types for GET Jobs endpoint
|
|
9851
9947
|
*
|
|
@@ -10382,6 +10478,87 @@ export type POST_JobsByBatchIdResume_Response_404 = Problem
|
|
|
10382
10478
|
*/
|
|
10383
10479
|
export type POST_JobsByBatchIdResume_Response_422 = HTTPValidationError
|
|
10384
10480
|
|
|
10481
|
+
/**
|
|
10482
|
+
* Response types for POST JobsByBatchIdRetry endpoint
|
|
10483
|
+
*
|
|
10484
|
+
* Retry failed and dead-lettered jobs in a batch
|
|
10485
|
+
*
|
|
10486
|
+
* @remarks
|
|
10487
|
+
* This type defines all possible response structures for the POST JobsByBatchIdRetry endpoint.
|
|
10488
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
10489
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
10490
|
+
*
|
|
10491
|
+
|
|
10492
|
+
*
|
|
10493
|
+
* @path /v1/jobs/{batch_id}/retry
|
|
10494
|
+
* @param batch_id (path) - Batch ID
|
|
10495
|
+
* @param error_class (query) - Optional repeatable filter: only retry jobs whose error_class matches one of these values. Example: `?error_class=BillingInsufficientFundsError` to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered jobs in the batch.
|
|
10496
|
+
*
|
|
10497
|
+
* @see {@link POST_JobsByBatchIdRetry_Response_200} - 200 response type
|
|
10498
|
+
* @see {@link POST_JobsByBatchIdRetry_Response_404} - 404 response type
|
|
10499
|
+
* @see {@link POST_JobsByBatchIdRetry_Response_422} - 422 response type
|
|
10500
|
+
*
|
|
10501
|
+
|
|
10502
|
+
*/
|
|
10503
|
+
export type POST_JobsByBatchIdRetry_Response = POST_JobsByBatchIdRetry_Response_200 | POST_JobsByBatchIdRetry_Response_404 | POST_JobsByBatchIdRetry_Response_422;
|
|
10504
|
+
|
|
10505
|
+
/**
|
|
10506
|
+
* 200 response for POST JobsByBatchIdRetry endpoint
|
|
10507
|
+
*
|
|
10508
|
+
* @remarks
|
|
10509
|
+
* This type defines the response structure for the 200 status code
|
|
10510
|
+
* of the POST JobsByBatchIdRetry endpoint.
|
|
10511
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
10512
|
+
*
|
|
10513
|
+
|
|
10514
|
+
*
|
|
10515
|
+
* @path /v1/jobs/{batch_id}/retry
|
|
10516
|
+
* @param batch_id (path) - Batch ID
|
|
10517
|
+
* @param error_class (query) - Optional repeatable filter: only retry jobs whose error_class matches one of these values. Example: `?error_class=BillingInsufficientFundsError` to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered jobs in the batch.
|
|
10518
|
+
*
|
|
10519
|
+
* @see {@link POST_JobsByBatchIdRetry_Response} - The main response type definition
|
|
10520
|
+
* @see {@link JobBatchRetry} - The actual schema type definition
|
|
10521
|
+
*/
|
|
10522
|
+
export type POST_JobsByBatchIdRetry_Response_200 = JobBatchRetry
|
|
10523
|
+
|
|
10524
|
+
/**
|
|
10525
|
+
* 404 response for POST JobsByBatchIdRetry endpoint
|
|
10526
|
+
*
|
|
10527
|
+
* @remarks
|
|
10528
|
+
* This type defines the response structure for the 404 status code
|
|
10529
|
+
* of the POST JobsByBatchIdRetry endpoint.
|
|
10530
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
10531
|
+
*
|
|
10532
|
+
|
|
10533
|
+
*
|
|
10534
|
+
* @path /v1/jobs/{batch_id}/retry
|
|
10535
|
+
* @param batch_id (path) - Batch ID
|
|
10536
|
+
* @param error_class (query) - Optional repeatable filter: only retry jobs whose error_class matches one of these values. Example: `?error_class=BillingInsufficientFundsError` to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered jobs in the batch.
|
|
10537
|
+
*
|
|
10538
|
+
* @see {@link POST_JobsByBatchIdRetry_Response} - The main response type definition
|
|
10539
|
+
* @see {@link Problem} - The actual schema type definition
|
|
10540
|
+
*/
|
|
10541
|
+
export type POST_JobsByBatchIdRetry_Response_404 = Problem
|
|
10542
|
+
|
|
10543
|
+
/**
|
|
10544
|
+
* 422 response for POST JobsByBatchIdRetry endpoint
|
|
10545
|
+
*
|
|
10546
|
+
* @remarks
|
|
10547
|
+
* This type defines the response structure for the 422 status code
|
|
10548
|
+
* of the POST JobsByBatchIdRetry endpoint.
|
|
10549
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
10550
|
+
*
|
|
10551
|
+
|
|
10552
|
+
*
|
|
10553
|
+
* @path /v1/jobs/{batch_id}/retry
|
|
10554
|
+
* @param batch_id (path) - Batch ID
|
|
10555
|
+
* @param error_class (query) - Optional repeatable filter: only retry jobs whose error_class matches one of these values. Example: `?error_class=BillingInsufficientFundsError` to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered jobs in the batch.
|
|
10556
|
+
*
|
|
10557
|
+
* @see {@link POST_JobsByBatchIdRetry_Response} - The main response type definition
|
|
10558
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
10559
|
+
*/
|
|
10560
|
+
export type POST_JobsByBatchIdRetry_Response_422 = HTTPValidationError
|
|
10561
|
+
|
|
10385
10562
|
/**
|
|
10386
10563
|
* Response types for GET Organizations endpoint
|
|
10387
10564
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -3924,6 +3924,22 @@ export type JobBatchMetadata = components['schemas']['JobBatchMetadataResponse']
|
|
|
3924
3924
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3925
3925
|
*/
|
|
3926
3926
|
export type JobBatchRequest = components['schemas']['JobBatchRequest'];
|
|
3927
|
+
/**
|
|
3928
|
+
* JobBatchRetryResponse
|
|
3929
|
+
*
|
|
3930
|
+
* @remarks
|
|
3931
|
+
* Type alias for the `JobBatchRetryResponse` OpenAPI schema.
|
|
3932
|
+
* This type represents jobbatchretryresponse data structures used in API requests and responses.
|
|
3933
|
+
*
|
|
3934
|
+
* @example
|
|
3935
|
+
* ```typescript
|
|
3936
|
+
* const response = await api.getJobBatchRetry();
|
|
3937
|
+
* const item: JobBatchRetry = response.results;
|
|
3938
|
+
* ```
|
|
3939
|
+
*
|
|
3940
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3941
|
+
*/
|
|
3942
|
+
export type JobBatchRetry = components['schemas']['JobBatchRetryResponse'];
|
|
3927
3943
|
/**
|
|
3928
3944
|
* JobBatchStatusResponse
|
|
3929
3945
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -5693,6 +5693,7 @@ components:
|
|
|
5693
5693
|
- DOMAIN
|
|
5694
5694
|
- CONTACT
|
|
5695
5695
|
- HOST
|
|
5696
|
+
- ACCOUNT
|
|
5696
5697
|
- RAW
|
|
5697
5698
|
- UNKNOWN
|
|
5698
5699
|
title: EventObjectType
|
|
@@ -5774,6 +5775,7 @@ components:
|
|
|
5774
5775
|
- TRANSIT
|
|
5775
5776
|
- WITHDRAW
|
|
5776
5777
|
- VERIFICATION
|
|
5778
|
+
- BALANCE
|
|
5777
5779
|
title: EventType
|
|
5778
5780
|
type: string
|
|
5779
5781
|
EventVersion:
|
|
@@ -6399,6 +6401,26 @@ components:
|
|
|
6399
6401
|
- commands
|
|
6400
6402
|
title: JobBatchRequest
|
|
6401
6403
|
type: object
|
|
6404
|
+
JobBatchRetryResponse:
|
|
6405
|
+
properties:
|
|
6406
|
+
batch_id:
|
|
6407
|
+
description: TypeID identifying this batch
|
|
6408
|
+
examples:
|
|
6409
|
+
- batch_01h45ytscbebyvny4gc8cr8ma2
|
|
6410
|
+
format: typeid
|
|
6411
|
+
pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
6412
|
+
title: Batch Id
|
|
6413
|
+
type: string
|
|
6414
|
+
x-typeid-prefix: batch
|
|
6415
|
+
retried_count:
|
|
6416
|
+
description: Number of FAILED/DEAD_LETTER jobs reset to QUEUED for retry
|
|
6417
|
+
title: Retried Count
|
|
6418
|
+
type: integer
|
|
6419
|
+
required:
|
|
6420
|
+
- batch_id
|
|
6421
|
+
- retried_count
|
|
6422
|
+
title: JobBatchRetryResponse
|
|
6423
|
+
type: object
|
|
6402
6424
|
JobBatchStatusResponse:
|
|
6403
6425
|
properties:
|
|
6404
6426
|
batch_id:
|
|
@@ -11305,7 +11327,7 @@ info:
|
|
|
11305
11327
|
\n\n"
|
|
11306
11328
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
11307
11329
|
title: OpusDNS API
|
|
11308
|
-
version: 2026-05-
|
|
11330
|
+
version: 2026-05-14-144015
|
|
11309
11331
|
x-logo:
|
|
11310
11332
|
altText: OpusDNS API Reference
|
|
11311
11333
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -21067,6 +21089,66 @@ paths:
|
|
|
21067
21089
|
summary: Resume a paused job
|
|
21068
21090
|
tags:
|
|
21069
21091
|
- jobs
|
|
21092
|
+
/v1/job/{job_id}/retry:
|
|
21093
|
+
post:
|
|
21094
|
+
operationId: retry_job_v1_job__job_id__retry_post
|
|
21095
|
+
parameters:
|
|
21096
|
+
- description: Job ID
|
|
21097
|
+
in: path
|
|
21098
|
+
name: job_id
|
|
21099
|
+
required: true
|
|
21100
|
+
schema:
|
|
21101
|
+
examples:
|
|
21102
|
+
- job_01h45ytscbebyvny4gc8cr8ma2
|
|
21103
|
+
format: typeid
|
|
21104
|
+
pattern: ^job_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
21105
|
+
title: Job Id
|
|
21106
|
+
type: string
|
|
21107
|
+
x-typeid-prefix: job
|
|
21108
|
+
responses:
|
|
21109
|
+
'200':
|
|
21110
|
+
content:
|
|
21111
|
+
application/json:
|
|
21112
|
+
schema:
|
|
21113
|
+
$ref: '#/components/schemas/JobResponse'
|
|
21114
|
+
description: Successful Response
|
|
21115
|
+
'404':
|
|
21116
|
+
content:
|
|
21117
|
+
application/problem+json:
|
|
21118
|
+
example:
|
|
21119
|
+
code: ERROR_JOB_NOT_FOUND
|
|
21120
|
+
detail: No job found with id 'Additional error context.'
|
|
21121
|
+
job_id: Additional error context.
|
|
21122
|
+
status: 404
|
|
21123
|
+
title: Batch Operation Error
|
|
21124
|
+
type: job-not-found
|
|
21125
|
+
schema:
|
|
21126
|
+
$ref: '#/components/schemas/Problem'
|
|
21127
|
+
description: Not Found
|
|
21128
|
+
'409':
|
|
21129
|
+
content:
|
|
21130
|
+
application/problem+json:
|
|
21131
|
+
example:
|
|
21132
|
+
code: ERROR_JOB_STATUS_CONFLICT
|
|
21133
|
+
detail: Additional error context.
|
|
21134
|
+
status: 409
|
|
21135
|
+
title: Batch Operation Error
|
|
21136
|
+
type: job-status-conflict
|
|
21137
|
+
schema:
|
|
21138
|
+
$ref: '#/components/schemas/Problem'
|
|
21139
|
+
description: Conflict
|
|
21140
|
+
'422':
|
|
21141
|
+
content:
|
|
21142
|
+
application/problem+json:
|
|
21143
|
+
schema:
|
|
21144
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
21145
|
+
description: Validation Error
|
|
21146
|
+
security:
|
|
21147
|
+
- OAuth2PasswordBearer: []
|
|
21148
|
+
- APIKeyHeader: []
|
|
21149
|
+
summary: Retry a failed or dead-lettered job
|
|
21150
|
+
tags:
|
|
21151
|
+
- jobs
|
|
21070
21152
|
/v1/jobs:
|
|
21071
21153
|
get:
|
|
21072
21154
|
operationId: list_batches_v1_jobs_get
|
|
@@ -22128,6 +22210,72 @@ paths:
|
|
|
22128
22210
|
summary: Resume all paused jobs in a batch
|
|
22129
22211
|
tags:
|
|
22130
22212
|
- jobs
|
|
22213
|
+
/v1/jobs/{batch_id}/retry:
|
|
22214
|
+
post:
|
|
22215
|
+
operationId: retry_batch_v1_jobs__batch_id__retry_post
|
|
22216
|
+
parameters:
|
|
22217
|
+
- description: Batch ID
|
|
22218
|
+
in: path
|
|
22219
|
+
name: batch_id
|
|
22220
|
+
required: true
|
|
22221
|
+
schema:
|
|
22222
|
+
examples:
|
|
22223
|
+
- batch_01h45ytscbebyvny4gc8cr8ma2
|
|
22224
|
+
format: typeid
|
|
22225
|
+
pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
22226
|
+
title: Batch Id
|
|
22227
|
+
type: string
|
|
22228
|
+
x-typeid-prefix: batch
|
|
22229
|
+
- description: 'Optional repeatable filter: only retry jobs whose error_class
|
|
22230
|
+
matches one of these values. Example: `?error_class=BillingInsufficientFundsError`
|
|
22231
|
+
to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered
|
|
22232
|
+
jobs in the batch.'
|
|
22233
|
+
in: query
|
|
22234
|
+
name: error_class
|
|
22235
|
+
required: false
|
|
22236
|
+
schema:
|
|
22237
|
+
anyOf:
|
|
22238
|
+
- items:
|
|
22239
|
+
type: string
|
|
22240
|
+
type: array
|
|
22241
|
+
- type: 'null'
|
|
22242
|
+
description: 'Optional repeatable filter: only retry jobs whose error_class
|
|
22243
|
+
matches one of these values. Example: `?error_class=BillingInsufficientFundsError`
|
|
22244
|
+
to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered
|
|
22245
|
+
jobs in the batch.'
|
|
22246
|
+
title: Error Class
|
|
22247
|
+
responses:
|
|
22248
|
+
'200':
|
|
22249
|
+
content:
|
|
22250
|
+
application/json:
|
|
22251
|
+
schema:
|
|
22252
|
+
$ref: '#/components/schemas/JobBatchRetryResponse'
|
|
22253
|
+
description: Successful Response
|
|
22254
|
+
'404':
|
|
22255
|
+
content:
|
|
22256
|
+
application/problem+json:
|
|
22257
|
+
example:
|
|
22258
|
+
code: ERROR_BATCH_NOT_FOUND
|
|
22259
|
+
correlation_id: Additional error context.
|
|
22260
|
+
detail: No batch found with correlation_id 'Additional error context.'
|
|
22261
|
+
status: 404
|
|
22262
|
+
title: Batch Operation Error
|
|
22263
|
+
type: batch-not-found
|
|
22264
|
+
schema:
|
|
22265
|
+
$ref: '#/components/schemas/Problem'
|
|
22266
|
+
description: Not Found
|
|
22267
|
+
'422':
|
|
22268
|
+
content:
|
|
22269
|
+
application/problem+json:
|
|
22270
|
+
schema:
|
|
22271
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
22272
|
+
description: Validation Error
|
|
22273
|
+
security:
|
|
22274
|
+
- OAuth2PasswordBearer: []
|
|
22275
|
+
- APIKeyHeader: []
|
|
22276
|
+
summary: Retry failed and dead-lettered jobs in a batch
|
|
22277
|
+
tags:
|
|
22278
|
+
- jobs
|
|
22131
22279
|
/v1/organizations:
|
|
22132
22280
|
get:
|
|
22133
22281
|
description: Retrieves a paginated list of organizations under the current organization
|
|
@@ -25021,25 +25169,60 @@ tags:
|
|
|
25021
25169
|
\ **Review results** \u2014 `GET /v1/jobs/{batch_id}/jobs` to see individual job\
|
|
25022
25170
|
\ outcomes\n\n### Managing Batches\n\n- **Pause** \u2014 `POST /v1/jobs/{batch_id}/pause`\
|
|
25023
25171
|
\ pauses all eligible jobs in the batch\n- **Resume** \u2014 `POST /v1/jobs/{batch_id}/resume`\
|
|
25024
|
-
\ resumes all paused jobs\n- **
|
|
25025
|
-
\
|
|
25026
|
-
|
|
25027
|
-
\
|
|
25028
|
-
\
|
|
25029
|
-
\
|
|
25030
|
-
\
|
|
25031
|
-
\
|
|
25032
|
-
\
|
|
25033
|
-
|
|
25034
|
-
\
|
|
25035
|
-
\
|
|
25036
|
-
\
|
|
25037
|
-
\
|
|
25038
|
-
\ in
|
|
25039
|
-
\
|
|
25040
|
-
\
|
|
25041
|
-
\
|
|
25042
|
-
\
|
|
25172
|
+
\ resumes all paused jobs\n- **Retry** \u2014 `POST /v1/jobs/{batch_id}/retry`\
|
|
25173
|
+
\ retries failed and dead-lettered jobs in the batch (see [Retrying Failed Jobs](#retrying-failed-jobs))\n\
|
|
25174
|
+
- **Cancel** \u2014 `DELETE /v1/jobs/{batch_id}` cancels all pending jobs in the\
|
|
25175
|
+
\ batch\n\nIndividual jobs can also be paused, resumed, retried, or canceled via\
|
|
25176
|
+
\ the `/v1/job/{job_id}` endpoints.\n\n### Retrying Failed Jobs\n\nIf jobs in\
|
|
25177
|
+
\ a batch end up in `failed` or `dead_letter` state \u2014 for example because\
|
|
25178
|
+
\ the account had insufficient funds at the time the batch was processed \u2014\
|
|
25179
|
+
\ you can re-attempt them without rebuilding the batch from scratch.\n\n- **Single\
|
|
25180
|
+
\ job:** `POST /v1/job/{job_id}/retry`\n- **Whole batch:** `POST /v1/jobs/{batch_id}/retry`\n\
|
|
25181
|
+
\n#### What gets retried\n\nOnly jobs in `failed` or `dead_letter` status are\
|
|
25182
|
+
\ eligible. Jobs in any other status are left unchanged:\n\n- `succeeded` \u2014\
|
|
25183
|
+
\ already complete; retrying returns **409 Conflict**\n- `canceled` \u2014 you\
|
|
25184
|
+
\ explicitly canceled these, so the retry won't undo that; returns **409 Conflict**\
|
|
25185
|
+
\ (single) or is silently skipped (batch)\n- `queued`, `blocked`, `paused`, `running`\
|
|
25186
|
+
\ \u2014 still in progress; not touched\n\nCalling batch retry on a mixed-state\
|
|
25187
|
+
\ batch returns `retried_count` (the number of `failed` / `dead_letter` jobs that\
|
|
25188
|
+
\ were re-queued); everything else is left alone. If the batch has no retryable\
|
|
25189
|
+
\ jobs, `retried_count` is `0`.\n\n#### What happens to a retried job\n\nEach\
|
|
25190
|
+
\ retried job is reset to a fresh attempt:\n\n- `status` \u2192 `queued`\n- `attempts`\
|
|
25191
|
+
\ \u2192 `0`\n- `not_before` \u2192 now\n- `error_class` and `error_message` \u2192\
|
|
25192
|
+
\ cleared\n- The job is republished for worker pickup\n\nThe original `payload`,\
|
|
25193
|
+
\ `idempotency_key`, `correlation_id` (batch id), `max_attempts`, and backoff\
|
|
25194
|
+
\ configuration are preserved. Each retry is processed under the same worker idempotency\
|
|
25195
|
+
\ guarantees as the original \u2014 for billing operations specifically, a retried\
|
|
25196
|
+
\ job will not double-charge an account that was already debited.\n\n#### Filtering\
|
|
25197
|
+
\ by error type\n\nA batch may contain a mix of failures that you do and don't\
|
|
25198
|
+
\ want to retry. For example, after adding funds to your account, you may want\
|
|
25199
|
+
\ to retry only the jobs that failed with `BillingInsufficientFundsError`, while\
|
|
25200
|
+
\ leaving alone jobs that failed for other reasons (e.g. an invalid domain name\
|
|
25201
|
+
\ that should not be re-attempted).\n\nPass one or more `error_class` query parameters\
|
|
25202
|
+
\ to filter:\n\n```\nPOST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError\n\
|
|
25203
|
+
POST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError&error_class=DomainRegistryTemporaryError\n\
|
|
25204
|
+
```\n\nMultiple values are OR'd \u2014 a job is retried if its `error_class` matches\
|
|
25205
|
+
\ **any** of the supplied values. Omitting the filter retries all `failed` and\
|
|
25206
|
+
\ `dead_letter` jobs in the batch.\n\nThe `error_class` for each failed job is\
|
|
25207
|
+
\ visible on the individual job response (`GET /v1/jobs/{batch_id}/jobs`), so\
|
|
25208
|
+
\ the typical flow is:\n\n1. List the failed jobs in the batch and group by `error_class`.\n\
|
|
25209
|
+
2. Determine which failures are recoverable.\n3. Call retry with the relevant\
|
|
25210
|
+
\ `error_class` filter.\n\n### Limits\n\n- Maximum **50,000 commands** per batch\n\
|
|
25211
|
+
- Bulk commands support up to **1,000 instances** per command\n\n### Scheduling\n\
|
|
25212
|
+
\nUse `not_before` to schedule batch execution for a future time (UTC timestamp).\
|
|
25213
|
+
\ If not provided, processing begins as soon as a worker is available.\n\n###\
|
|
25214
|
+
\ Idempotency\n\nEach command can include an optional `idempotency_key` to prevent\
|
|
25215
|
+
\ duplicate execution. If a command with the same idempotency key has already\
|
|
25216
|
+
\ been processed, it will be skipped.\n\n### Domain Status Updates in Batches\n\
|
|
25217
|
+
\nThe `domain_update` and `domain_update_bulk` commands support two mutually exclusive\
|
|
25218
|
+
\ approaches for modifying domain statuses. These work the same way as the `PATCH\
|
|
25219
|
+
\ /v1/domains/{domain_reference}` endpoint \u2014 see the [Domain management](#tag/Domain-management)\
|
|
25220
|
+
\ documentation for full details on `statuses` vs `status_changes`.\n\n#### Using\
|
|
25221
|
+
\ `status_changes` in bulk templates\n\nThe `domain_update_bulk` command is particularly\
|
|
25222
|
+
\ useful with `status_changes` when you need to apply the same relative status\
|
|
25223
|
+
\ change across many domains. Set `status_changes` in the **template** and list\
|
|
25224
|
+
\ the target domains as **instances**. Each instance identifies a domain by either\
|
|
25225
|
+
\ `name` or `domain_id` (but not both):\n\n```json\n{\n \"command\": \"domain_update_bulk\"\
|
|
25043
25226
|
,\n \"payload\": {\n \"template\": {\n \"status_changes\": {\n \
|
|
25044
25227
|
\ \"add\": [\"clientTransferProhibited\"]\n }\n },\n \"instances\"\
|
|
25045
25228
|
: [\n { \"name\": \"example.com\" },\n { \"name\": \"example.net\" },\n\
|
package/src/schema.d.ts
CHANGED
|
@@ -1580,6 +1580,23 @@ export interface paths {
|
|
|
1580
1580
|
patch?: never;
|
|
1581
1581
|
trace?: never;
|
|
1582
1582
|
};
|
|
1583
|
+
"/v1/job/{job_id}/retry": {
|
|
1584
|
+
parameters: {
|
|
1585
|
+
query?: never;
|
|
1586
|
+
header?: never;
|
|
1587
|
+
path?: never;
|
|
1588
|
+
cookie?: never;
|
|
1589
|
+
};
|
|
1590
|
+
get?: never;
|
|
1591
|
+
put?: never;
|
|
1592
|
+
/** Retry a failed or dead-lettered job */
|
|
1593
|
+
post: operations["retry_job_v1_job__job_id__retry_post"];
|
|
1594
|
+
delete?: never;
|
|
1595
|
+
options?: never;
|
|
1596
|
+
head?: never;
|
|
1597
|
+
patch?: never;
|
|
1598
|
+
trace?: never;
|
|
1599
|
+
};
|
|
1583
1600
|
"/v1/jobs": {
|
|
1584
1601
|
parameters: {
|
|
1585
1602
|
query?: never;
|
|
@@ -1667,6 +1684,23 @@ export interface paths {
|
|
|
1667
1684
|
patch?: never;
|
|
1668
1685
|
trace?: never;
|
|
1669
1686
|
};
|
|
1687
|
+
"/v1/jobs/{batch_id}/retry": {
|
|
1688
|
+
parameters: {
|
|
1689
|
+
query?: never;
|
|
1690
|
+
header?: never;
|
|
1691
|
+
path?: never;
|
|
1692
|
+
cookie?: never;
|
|
1693
|
+
};
|
|
1694
|
+
get?: never;
|
|
1695
|
+
put?: never;
|
|
1696
|
+
/** Retry failed and dead-lettered jobs in a batch */
|
|
1697
|
+
post: operations["retry_batch_v1_jobs__batch_id__retry_post"];
|
|
1698
|
+
delete?: never;
|
|
1699
|
+
options?: never;
|
|
1700
|
+
head?: never;
|
|
1701
|
+
patch?: never;
|
|
1702
|
+
trace?: never;
|
|
1703
|
+
};
|
|
1670
1704
|
"/v1/organizations": {
|
|
1671
1705
|
parameters: {
|
|
1672
1706
|
query?: never;
|
|
@@ -6229,7 +6263,7 @@ export interface components {
|
|
|
6229
6263
|
* EventObjectType
|
|
6230
6264
|
* @enum {string}
|
|
6231
6265
|
*/
|
|
6232
|
-
EventObjectType: "DOMAIN" | "CONTACT" | "HOST" | "RAW" | "UNKNOWN";
|
|
6266
|
+
EventObjectType: "DOMAIN" | "CONTACT" | "HOST" | "ACCOUNT" | "RAW" | "UNKNOWN";
|
|
6233
6267
|
/** EventResponse */
|
|
6234
6268
|
EventResponse: {
|
|
6235
6269
|
/**
|
|
@@ -6279,7 +6313,7 @@ export interface components {
|
|
|
6279
6313
|
* EventType
|
|
6280
6314
|
* @enum {string}
|
|
6281
6315
|
*/
|
|
6282
|
-
EventType: "REGISTRATION" | "RENEWAL" | "MODIFICATION" | "DELETION" | "INBOUND_TRANSFER" | "OUTBOUND_TRANSFER" | "TRANSIT" | "WITHDRAW" | "VERIFICATION";
|
|
6316
|
+
EventType: "REGISTRATION" | "RENEWAL" | "MODIFICATION" | "DELETION" | "INBOUND_TRANSFER" | "OUTBOUND_TRANSFER" | "TRANSIT" | "WITHDRAW" | "VERIFICATION" | "BALANCE";
|
|
6283
6317
|
/**
|
|
6284
6318
|
* EventVersion
|
|
6285
6319
|
* @enum {string}
|
|
@@ -6677,6 +6711,21 @@ export interface components {
|
|
|
6677
6711
|
*/
|
|
6678
6712
|
paused: boolean;
|
|
6679
6713
|
};
|
|
6714
|
+
/** JobBatchRetryResponse */
|
|
6715
|
+
JobBatchRetryResponse: {
|
|
6716
|
+
/**
|
|
6717
|
+
* Batch Id
|
|
6718
|
+
* Format: typeid
|
|
6719
|
+
* @description TypeID identifying this batch
|
|
6720
|
+
* @example batch_01h45ytscbebyvny4gc8cr8ma2
|
|
6721
|
+
*/
|
|
6722
|
+
batch_id: TypeId<"batch">;
|
|
6723
|
+
/**
|
|
6724
|
+
* Retried Count
|
|
6725
|
+
* @description Number of FAILED/DEAD_LETTER jobs reset to QUEUED for retry
|
|
6726
|
+
*/
|
|
6727
|
+
retried_count: number;
|
|
6728
|
+
};
|
|
6680
6729
|
/** JobBatchStatusResponse */
|
|
6681
6730
|
JobBatchStatusResponse: {
|
|
6682
6731
|
/**
|
|
@@ -17183,6 +17232,71 @@ export interface operations {
|
|
|
17183
17232
|
};
|
|
17184
17233
|
};
|
|
17185
17234
|
};
|
|
17235
|
+
retry_job_v1_job__job_id__retry_post: {
|
|
17236
|
+
parameters: {
|
|
17237
|
+
query?: never;
|
|
17238
|
+
header?: never;
|
|
17239
|
+
path: {
|
|
17240
|
+
/** @description Job ID */
|
|
17241
|
+
job_id: TypeId<"job">;
|
|
17242
|
+
};
|
|
17243
|
+
cookie?: never;
|
|
17244
|
+
};
|
|
17245
|
+
requestBody?: never;
|
|
17246
|
+
responses: {
|
|
17247
|
+
/** @description Successful Response */
|
|
17248
|
+
200: {
|
|
17249
|
+
headers: {
|
|
17250
|
+
[name: string]: unknown;
|
|
17251
|
+
};
|
|
17252
|
+
content: {
|
|
17253
|
+
"application/json": components["schemas"]["JobResponse"];
|
|
17254
|
+
};
|
|
17255
|
+
};
|
|
17256
|
+
/** @description Not Found */
|
|
17257
|
+
404: {
|
|
17258
|
+
headers: {
|
|
17259
|
+
[name: string]: unknown;
|
|
17260
|
+
};
|
|
17261
|
+
content: {
|
|
17262
|
+
/** @example {
|
|
17263
|
+
* "code": "ERROR_JOB_NOT_FOUND",
|
|
17264
|
+
* "detail": "No job found with id 'Additional error context.'",
|
|
17265
|
+
* "job_id": "Additional error context.",
|
|
17266
|
+
* "status": 404,
|
|
17267
|
+
* "title": "Batch Operation Error",
|
|
17268
|
+
* "type": "job-not-found"
|
|
17269
|
+
* } */
|
|
17270
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
17271
|
+
};
|
|
17272
|
+
};
|
|
17273
|
+
/** @description Conflict */
|
|
17274
|
+
409: {
|
|
17275
|
+
headers: {
|
|
17276
|
+
[name: string]: unknown;
|
|
17277
|
+
};
|
|
17278
|
+
content: {
|
|
17279
|
+
/** @example {
|
|
17280
|
+
* "code": "ERROR_JOB_STATUS_CONFLICT",
|
|
17281
|
+
* "detail": "Additional error context.",
|
|
17282
|
+
* "status": 409,
|
|
17283
|
+
* "title": "Batch Operation Error",
|
|
17284
|
+
* "type": "job-status-conflict"
|
|
17285
|
+
* } */
|
|
17286
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
17287
|
+
};
|
|
17288
|
+
};
|
|
17289
|
+
/** @description Validation Error */
|
|
17290
|
+
422: {
|
|
17291
|
+
headers: {
|
|
17292
|
+
[name: string]: unknown;
|
|
17293
|
+
};
|
|
17294
|
+
content: {
|
|
17295
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
17296
|
+
};
|
|
17297
|
+
};
|
|
17298
|
+
};
|
|
17299
|
+
};
|
|
17186
17300
|
list_batches_v1_jobs_get: {
|
|
17187
17301
|
parameters: {
|
|
17188
17302
|
query?: {
|
|
@@ -17569,6 +17683,58 @@ export interface operations {
|
|
|
17569
17683
|
};
|
|
17570
17684
|
};
|
|
17571
17685
|
};
|
|
17686
|
+
retry_batch_v1_jobs__batch_id__retry_post: {
|
|
17687
|
+
parameters: {
|
|
17688
|
+
query?: {
|
|
17689
|
+
/** @description Optional repeatable filter: only retry jobs whose error_class matches one of these values. Example: `?error_class=BillingInsufficientFundsError` to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered jobs in the batch. */
|
|
17690
|
+
error_class?: string[] | null;
|
|
17691
|
+
};
|
|
17692
|
+
header?: never;
|
|
17693
|
+
path: {
|
|
17694
|
+
/** @description Batch ID */
|
|
17695
|
+
batch_id: TypeId<"batch">;
|
|
17696
|
+
};
|
|
17697
|
+
cookie?: never;
|
|
17698
|
+
};
|
|
17699
|
+
requestBody?: never;
|
|
17700
|
+
responses: {
|
|
17701
|
+
/** @description Successful Response */
|
|
17702
|
+
200: {
|
|
17703
|
+
headers: {
|
|
17704
|
+
[name: string]: unknown;
|
|
17705
|
+
};
|
|
17706
|
+
content: {
|
|
17707
|
+
"application/json": components["schemas"]["JobBatchRetryResponse"];
|
|
17708
|
+
};
|
|
17709
|
+
};
|
|
17710
|
+
/** @description Not Found */
|
|
17711
|
+
404: {
|
|
17712
|
+
headers: {
|
|
17713
|
+
[name: string]: unknown;
|
|
17714
|
+
};
|
|
17715
|
+
content: {
|
|
17716
|
+
/** @example {
|
|
17717
|
+
* "code": "ERROR_BATCH_NOT_FOUND",
|
|
17718
|
+
* "correlation_id": "Additional error context.",
|
|
17719
|
+
* "detail": "No batch found with correlation_id 'Additional error context.'",
|
|
17720
|
+
* "status": 404,
|
|
17721
|
+
* "title": "Batch Operation Error",
|
|
17722
|
+
* "type": "batch-not-found"
|
|
17723
|
+
* } */
|
|
17724
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
17725
|
+
};
|
|
17726
|
+
};
|
|
17727
|
+
/** @description Validation Error */
|
|
17728
|
+
422: {
|
|
17729
|
+
headers: {
|
|
17730
|
+
[name: string]: unknown;
|
|
17731
|
+
};
|
|
17732
|
+
content: {
|
|
17733
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
17734
|
+
};
|
|
17735
|
+
};
|
|
17736
|
+
};
|
|
17737
|
+
};
|
|
17572
17738
|
list_organizations_v1_organizations_get: {
|
|
17573
17739
|
parameters: {
|
|
17574
17740
|
query?: {
|