@opusdns/api 0.299.0 → 0.300.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.299.0",
6
+ "version": "0.300.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -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
  *
@@ -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
@@ -6399,6 +6399,26 @@ components:
6399
6399
  - commands
6400
6400
  title: JobBatchRequest
6401
6401
  type: object
6402
+ JobBatchRetryResponse:
6403
+ properties:
6404
+ batch_id:
6405
+ description: TypeID identifying this batch
6406
+ examples:
6407
+ - batch_01h45ytscbebyvny4gc8cr8ma2
6408
+ format: typeid
6409
+ pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$
6410
+ title: Batch Id
6411
+ type: string
6412
+ x-typeid-prefix: batch
6413
+ retried_count:
6414
+ description: Number of FAILED/DEAD_LETTER jobs reset to QUEUED for retry
6415
+ title: Retried Count
6416
+ type: integer
6417
+ required:
6418
+ - batch_id
6419
+ - retried_count
6420
+ title: JobBatchRetryResponse
6421
+ type: object
6402
6422
  JobBatchStatusResponse:
6403
6423
  properties:
6404
6424
  batch_id:
@@ -11305,7 +11325,7 @@ info:
11305
11325
  \n\n"
11306
11326
  summary: OpusDNS - your gateway to a seamless domain management experience.
11307
11327
  title: OpusDNS API
11308
- version: 2026-05-13-153000
11328
+ version: 2026-05-14-142832
11309
11329
  x-logo:
11310
11330
  altText: OpusDNS API Reference
11311
11331
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -21067,6 +21087,66 @@ paths:
21067
21087
  summary: Resume a paused job
21068
21088
  tags:
21069
21089
  - jobs
21090
+ /v1/job/{job_id}/retry:
21091
+ post:
21092
+ operationId: retry_job_v1_job__job_id__retry_post
21093
+ parameters:
21094
+ - description: Job ID
21095
+ in: path
21096
+ name: job_id
21097
+ required: true
21098
+ schema:
21099
+ examples:
21100
+ - job_01h45ytscbebyvny4gc8cr8ma2
21101
+ format: typeid
21102
+ pattern: ^job_[0-7][0-9a-hjkmnpq-tv-z]{25}$
21103
+ title: Job Id
21104
+ type: string
21105
+ x-typeid-prefix: job
21106
+ responses:
21107
+ '200':
21108
+ content:
21109
+ application/json:
21110
+ schema:
21111
+ $ref: '#/components/schemas/JobResponse'
21112
+ description: Successful Response
21113
+ '404':
21114
+ content:
21115
+ application/problem+json:
21116
+ example:
21117
+ code: ERROR_JOB_NOT_FOUND
21118
+ detail: No job found with id 'Additional error context.'
21119
+ job_id: Additional error context.
21120
+ status: 404
21121
+ title: Batch Operation Error
21122
+ type: job-not-found
21123
+ schema:
21124
+ $ref: '#/components/schemas/Problem'
21125
+ description: Not Found
21126
+ '409':
21127
+ content:
21128
+ application/problem+json:
21129
+ example:
21130
+ code: ERROR_JOB_STATUS_CONFLICT
21131
+ detail: Additional error context.
21132
+ status: 409
21133
+ title: Batch Operation Error
21134
+ type: job-status-conflict
21135
+ schema:
21136
+ $ref: '#/components/schemas/Problem'
21137
+ description: Conflict
21138
+ '422':
21139
+ content:
21140
+ application/problem+json:
21141
+ schema:
21142
+ $ref: '#/components/schemas/HTTPValidationError'
21143
+ description: Validation Error
21144
+ security:
21145
+ - OAuth2PasswordBearer: []
21146
+ - APIKeyHeader: []
21147
+ summary: Retry a failed or dead-lettered job
21148
+ tags:
21149
+ - jobs
21070
21150
  /v1/jobs:
21071
21151
  get:
21072
21152
  operationId: list_batches_v1_jobs_get
@@ -22128,6 +22208,72 @@ paths:
22128
22208
  summary: Resume all paused jobs in a batch
22129
22209
  tags:
22130
22210
  - jobs
22211
+ /v1/jobs/{batch_id}/retry:
22212
+ post:
22213
+ operationId: retry_batch_v1_jobs__batch_id__retry_post
22214
+ parameters:
22215
+ - description: Batch ID
22216
+ in: path
22217
+ name: batch_id
22218
+ required: true
22219
+ schema:
22220
+ examples:
22221
+ - batch_01h45ytscbebyvny4gc8cr8ma2
22222
+ format: typeid
22223
+ pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$
22224
+ title: Batch Id
22225
+ type: string
22226
+ x-typeid-prefix: batch
22227
+ - description: 'Optional repeatable filter: only retry jobs whose error_class
22228
+ matches one of these values. Example: `?error_class=BillingInsufficientFundsError`
22229
+ to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered
22230
+ jobs in the batch.'
22231
+ in: query
22232
+ name: error_class
22233
+ required: false
22234
+ schema:
22235
+ anyOf:
22236
+ - items:
22237
+ type: string
22238
+ type: array
22239
+ - type: 'null'
22240
+ description: 'Optional repeatable filter: only retry jobs whose error_class
22241
+ matches one of these values. Example: `?error_class=BillingInsufficientFundsError`
22242
+ to retry only insufficient-funds failures. Omit to retry all failed/dead-lettered
22243
+ jobs in the batch.'
22244
+ title: Error Class
22245
+ responses:
22246
+ '200':
22247
+ content:
22248
+ application/json:
22249
+ schema:
22250
+ $ref: '#/components/schemas/JobBatchRetryResponse'
22251
+ description: Successful Response
22252
+ '404':
22253
+ content:
22254
+ application/problem+json:
22255
+ example:
22256
+ code: ERROR_BATCH_NOT_FOUND
22257
+ correlation_id: Additional error context.
22258
+ detail: No batch found with correlation_id 'Additional error context.'
22259
+ status: 404
22260
+ title: Batch Operation Error
22261
+ type: batch-not-found
22262
+ schema:
22263
+ $ref: '#/components/schemas/Problem'
22264
+ description: Not Found
22265
+ '422':
22266
+ content:
22267
+ application/problem+json:
22268
+ schema:
22269
+ $ref: '#/components/schemas/HTTPValidationError'
22270
+ description: Validation Error
22271
+ security:
22272
+ - OAuth2PasswordBearer: []
22273
+ - APIKeyHeader: []
22274
+ summary: Retry failed and dead-lettered jobs in a batch
22275
+ tags:
22276
+ - jobs
22131
22277
  /v1/organizations:
22132
22278
  get:
22133
22279
  description: Retrieves a paginated list of organizations under the current organization
@@ -25021,25 +25167,60 @@ tags:
25021
25167
  \ **Review results** \u2014 `GET /v1/jobs/{batch_id}/jobs` to see individual job\
25022
25168
  \ outcomes\n\n### Managing Batches\n\n- **Pause** \u2014 `POST /v1/jobs/{batch_id}/pause`\
25023
25169
  \ pauses all eligible jobs in the batch\n- **Resume** \u2014 `POST /v1/jobs/{batch_id}/resume`\
25024
- \ resumes all paused jobs\n- **Cancel** \u2014 `DELETE /v1/jobs/{batch_id}` cancels\
25025
- \ all pending jobs in the batch\n\nIndividual jobs can also be paused, resumed,\
25026
- \ or canceled via the `/v1/job/{job_id}` endpoints.\n\n### Limits\n\n- Maximum\
25027
- \ **50,000 commands** per batch\n- Bulk commands support up to **1,000 instances**\
25028
- \ per command\n\n### Scheduling\n\nUse `not_before` to schedule batch execution\
25029
- \ for a future time (UTC timestamp). If not provided, processing begins as soon\
25030
- \ as a worker is available.\n\n### Idempotency\n\nEach command can include an\
25031
- \ optional `idempotency_key` to prevent duplicate execution. If a command with\
25032
- \ the same idempotency key has already been processed, it will be skipped.\n\n\
25033
- ### Domain Status Updates in Batches\n\nThe `domain_update` and `domain_update_bulk`\
25034
- \ commands support two mutually exclusive approaches for modifying domain statuses.\
25035
- \ These work the same way as the `PATCH /v1/domains/{domain_reference}` endpoint\
25036
- \ \u2014 see the [Domain management](#tag/Domain-management) documentation for\
25037
- \ full details on `statuses` vs `status_changes`.\n\n#### Using `status_changes`\
25038
- \ in bulk templates\n\nThe `domain_update_bulk` command is particularly useful\
25039
- \ with `status_changes` when you need to apply the same relative status change\
25040
- \ across many domains. Set `status_changes` in the **template** and list the target\
25041
- \ domains as **instances**. Each instance identifies a domain by either `name`\
25042
- \ or `domain_id` (but not both):\n\n```json\n{\n \"command\": \"domain_update_bulk\"\
25170
+ \ resumes all paused jobs\n- **Retry** \u2014 `POST /v1/jobs/{batch_id}/retry`\
25171
+ \ retries failed and dead-lettered jobs in the batch (see [Retrying Failed Jobs](#retrying-failed-jobs))\n\
25172
+ - **Cancel** \u2014 `DELETE /v1/jobs/{batch_id}` cancels all pending jobs in the\
25173
+ \ batch\n\nIndividual jobs can also be paused, resumed, retried, or canceled via\
25174
+ \ the `/v1/job/{job_id}` endpoints.\n\n### Retrying Failed Jobs\n\nIf jobs in\
25175
+ \ a batch end up in `failed` or `dead_letter` state \u2014 for example because\
25176
+ \ the account had insufficient funds at the time the batch was processed \u2014\
25177
+ \ you can re-attempt them without rebuilding the batch from scratch.\n\n- **Single\
25178
+ \ job:** `POST /v1/job/{job_id}/retry`\n- **Whole batch:** `POST /v1/jobs/{batch_id}/retry`\n\
25179
+ \n#### What gets retried\n\nOnly jobs in `failed` or `dead_letter` status are\
25180
+ \ eligible. Jobs in any other status are left unchanged:\n\n- `succeeded` \u2014\
25181
+ \ already complete; retrying returns **409 Conflict**\n- `canceled` \u2014 you\
25182
+ \ explicitly canceled these, so the retry won't undo that; returns **409 Conflict**\
25183
+ \ (single) or is silently skipped (batch)\n- `queued`, `blocked`, `paused`, `running`\
25184
+ \ \u2014 still in progress; not touched\n\nCalling batch retry on a mixed-state\
25185
+ \ batch returns `retried_count` (the number of `failed` / `dead_letter` jobs that\
25186
+ \ were re-queued); everything else is left alone. If the batch has no retryable\
25187
+ \ jobs, `retried_count` is `0`.\n\n#### What happens to a retried job\n\nEach\
25188
+ \ retried job is reset to a fresh attempt:\n\n- `status` \u2192 `queued`\n- `attempts`\
25189
+ \ \u2192 `0`\n- `not_before` \u2192 now\n- `error_class` and `error_message` \u2192\
25190
+ \ cleared\n- The job is republished for worker pickup\n\nThe original `payload`,\
25191
+ \ `idempotency_key`, `correlation_id` (batch id), `max_attempts`, and backoff\
25192
+ \ configuration are preserved. Each retry is processed under the same worker idempotency\
25193
+ \ guarantees as the original \u2014 for billing operations specifically, a retried\
25194
+ \ job will not double-charge an account that was already debited.\n\n#### Filtering\
25195
+ \ by error type\n\nA batch may contain a mix of failures that you do and don't\
25196
+ \ want to retry. For example, after adding funds to your account, you may want\
25197
+ \ to retry only the jobs that failed with `BillingInsufficientFundsError`, while\
25198
+ \ leaving alone jobs that failed for other reasons (e.g. an invalid domain name\
25199
+ \ that should not be re-attempted).\n\nPass one or more `error_class` query parameters\
25200
+ \ to filter:\n\n```\nPOST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError\n\
25201
+ POST /v1/jobs/{batch_id}/retry?error_class=BillingInsufficientFundsError&error_class=DomainRegistryTemporaryError\n\
25202
+ ```\n\nMultiple values are OR'd \u2014 a job is retried if its `error_class` matches\
25203
+ \ **any** of the supplied values. Omitting the filter retries all `failed` and\
25204
+ \ `dead_letter` jobs in the batch.\n\nThe `error_class` for each failed job is\
25205
+ \ visible on the individual job response (`GET /v1/jobs/{batch_id}/jobs`), so\
25206
+ \ the typical flow is:\n\n1. List the failed jobs in the batch and group by `error_class`.\n\
25207
+ 2. Determine which failures are recoverable.\n3. Call retry with the relevant\
25208
+ \ `error_class` filter.\n\n### Limits\n\n- Maximum **50,000 commands** per batch\n\
25209
+ - Bulk commands support up to **1,000 instances** per command\n\n### Scheduling\n\
25210
+ \nUse `not_before` to schedule batch execution for a future time (UTC timestamp).\
25211
+ \ If not provided, processing begins as soon as a worker is available.\n\n###\
25212
+ \ Idempotency\n\nEach command can include an optional `idempotency_key` to prevent\
25213
+ \ duplicate execution. If a command with the same idempotency key has already\
25214
+ \ been processed, it will be skipped.\n\n### Domain Status Updates in Batches\n\
25215
+ \nThe `domain_update` and `domain_update_bulk` commands support two mutually exclusive\
25216
+ \ approaches for modifying domain statuses. These work the same way as the `PATCH\
25217
+ \ /v1/domains/{domain_reference}` endpoint \u2014 see the [Domain management](#tag/Domain-management)\
25218
+ \ documentation for full details on `statuses` vs `status_changes`.\n\n#### Using\
25219
+ \ `status_changes` in bulk templates\n\nThe `domain_update_bulk` command is particularly\
25220
+ \ useful with `status_changes` when you need to apply the same relative status\
25221
+ \ change across many domains. Set `status_changes` in the **template** and list\
25222
+ \ the target domains as **instances**. Each instance identifies a domain by either\
25223
+ \ `name` or `domain_id` (but not both):\n\n```json\n{\n \"command\": \"domain_update_bulk\"\
25043
25224
  ,\n \"payload\": {\n \"template\": {\n \"status_changes\": {\n \
25044
25225
  \ \"add\": [\"clientTransferProhibited\"]\n }\n },\n \"instances\"\
25045
25226
  : [\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;
@@ -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?: {