@opusdns/api 0.298.0 → 0.300.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.298.0",
+  "version": "0.300.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -219,6 +219,7 @@ import { IpRestriction } from './schemas';
 import { IpRestrictionUpdate } from './schemas';
 import { JobBatchMetadata } from './schemas';
 import { JobBatchRequest } from './schemas';
+import { JobBatchRetry } from './schemas';
 import { JobBatchStatus } from './schemas';
 import { JobCountsByStatus } from './schemas';
 import { Job } from './schemas';
@@ -26648,6 +26649,84 @@ export const KEYS_JOB_BATCH_REQUEST = [
   KEY_JOB_BATCH_REQUEST_PAUSED,
 ] as const satisfies (keyof JobBatchRequest)[];
 
+/**
+ * Batch Id
+ *
+ * TypeID identifying this batch
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `batch_id` property of JobBatchRetry objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = jobbatchretry[KEY_JOB_BATCH_RETRY_BATCH_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_JOB_BATCH_RETRY_BATCH_ID;
+ * const value = jobbatchretry[propertyName];
+ * ```
+ *
+ * @see {@link JobBatchRetry} - The TypeScript type definition
+ * @see {@link KEYS_JOB_BATCH_RETRY} - Array of all keys for this type
+ */
+export const KEY_JOB_BATCH_RETRY_BATCH_ID: keyof JobBatchRetry = 'batch_id';
+/**
+ * Retried Count
+ *
+ * Number of FAILED/DEAD_LETTER jobs reset to QUEUED for retry
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `retried_count` property of JobBatchRetry objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = jobbatchretry[KEY_JOB_BATCH_RETRY_RETRIED_COUNT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_JOB_BATCH_RETRY_RETRIED_COUNT;
+ * const value = jobbatchretry[propertyName];
+ * ```
+ *
+ * @see {@link JobBatchRetry} - The TypeScript type definition
+ * @see {@link KEYS_JOB_BATCH_RETRY} - Array of all keys for this type
+ */
+export const KEY_JOB_BATCH_RETRY_RETRIED_COUNT: keyof JobBatchRetry = 'retried_count';
+
+/**
+ * Array of all JobBatchRetry property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for JobBatchRetry objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_JOB_BATCH_RETRY) {
+ *   console.log(`Property: ${key}, Value: ${jobbatchretry[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_JOB_BATCH_RETRY.includes(someKey);
+ * ```
+ *
+ * @see {@link JobBatchRetry} - The TypeScript type definition
+ */
+export const KEYS_JOB_BATCH_RETRY = [
+  KEY_JOB_BATCH_RETRY_BATCH_ID,
+  KEY_JOB_BATCH_RETRY_RETRIED_COUNT,
+] as const satisfies (keyof JobBatchRetry)[];
+
 /**
  * Batch Id
  *

package/src/helpers/requests.d.ts

@@ -4957,6 +4957,46 @@ export type POST_JobJobIdResume_Request = {
  */
 export type POST_JobJobIdResume_Request_Path = POST_JobJobIdResume_Request['parameters']['path'];
 
+/**
+ * Request type for POST JobJobIdRetry endpoint
+ *
+ * Retry a failed or dead-lettered job
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST JobJobIdRetry endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/job/{job_id}/retry
+ * @param job_id (path) - Job ID
+ *
+ * @see {@link POST_JobJobIdRetry_Request_Query} - Query parameters type
+ * @see {@link POST_JobJobIdRetry_Request_Path} - Path parameters type
+ * @see {@link POST_JobJobIdRetry_Request_Body} - Request body type
+ */
+export type POST_JobJobIdRetry_Request = {
+  parameters: {
+    path: operations['retry_job_v1_job__job_id__retry_post']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for POST /v1/job/{job_id}/retry
+ *
+ * @remarks
+ * This type defines the path parameters for the POST /v1/job/{job_id}/retry endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/job/{job_id}/retry
+ * @param job_id (path) - Job ID
+ */
+export type POST_JobJobIdRetry_Request_Path = POST_JobJobIdRetry_Request['parameters']['path'];
+
 /**
  * Request type for GET Jobs endpoint
  *
@@ -5257,6 +5297,62 @@ export type POST_JobsBatchIdResume_Request = {
  */
 export type POST_JobsBatchIdResume_Request_Path = POST_JobsBatchIdResume_Request['parameters']['path'];
 
+/**
+ * Request type for POST JobsBatchIdRetry endpoint
+ *
+ * Retry failed and dead-lettered jobs in a batch
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST JobsBatchIdRetry endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/jobs/{batch_id}/retry
+ * @param batch_id (path) - Batch ID
+ * @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.
+ *
+ * @see {@link POST_JobsBatchIdRetry_Request_Query} - Query parameters type
+ * @see {@link POST_JobsBatchIdRetry_Request_Path} - Path parameters type
+ * @see {@link POST_JobsBatchIdRetry_Request_Body} - Request body type
+ */
+export type POST_JobsBatchIdRetry_Request = {
+  parameters: {
+    query: operations['retry_batch_v1_jobs__batch_id__retry_post']['parameters']['query'];
+    path: operations['retry_batch_v1_jobs__batch_id__retry_post']['parameters']['path'];
+  };
+}
+/**
+ * Query parameters for POST /v1/jobs/{batch_id}/retry
+ *
+ * @remarks
+ * This type defines the query parameters for the POST /v1/jobs/{batch_id}/retry endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/jobs/{batch_id}/retry
+ * @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.
+ */
+export type POST_JobsBatchIdRetry_Request_Query = POST_JobsBatchIdRetry_Request['parameters']['query'];
+/**
+ * Path parameters for POST /v1/jobs/{batch_id}/retry
+ *
+ * @remarks
+ * This type defines the path parameters for the POST /v1/jobs/{batch_id}/retry endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/jobs/{batch_id}/retry
+ * @param batch_id (path) - Batch ID
+ */
+export type POST_JobsBatchIdRetry_Request_Path = POST_JobsBatchIdRetry_Request['parameters']['path'];
+
 /**
  * Request type for GET Organizations endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-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';
+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';
 
 /**
  * Response types for GET AiConciergeContextsByContextId endpoint
@@ -9846,6 +9846,102 @@ export type POST_JobByJobIdResume_Response_404 = Problem
  */
 export type POST_JobByJobIdResume_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST JobByJobIdRetry endpoint
+ *
+ * Retry a failed or dead-lettered job
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST JobByJobIdRetry endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/job/{job_id}/retry
+ * @param job_id (path) - Job ID
+ *
+ * @see {@link POST_JobByJobIdRetry_Response_200} - 200 response type
+ * @see {@link POST_JobByJobIdRetry_Response_404} - 404 response type
+ * @see {@link POST_JobByJobIdRetry_Response_409} - 409 response type
+ * @see {@link POST_JobByJobIdRetry_Response_422} - 422 response type
+ *
+
+ */
+export type POST_JobByJobIdRetry_Response = POST_JobByJobIdRetry_Response_200 | POST_JobByJobIdRetry_Response_404 | POST_JobByJobIdRetry_Response_409 | POST_JobByJobIdRetry_Response_422;
+
+/**
+ * 200 response for POST JobByJobIdRetry endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST JobByJobIdRetry endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/job/{job_id}/retry
+ * @param job_id (path) - Job ID
+ *
+ * @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
+ * @see {@link Job} - The actual schema type definition
+ */
+export type POST_JobByJobIdRetry_Response_200 = Job
+
+/**
+ * 404 response for POST JobByJobIdRetry endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST JobByJobIdRetry endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/job/{job_id}/retry
+ * @param job_id (path) - Job ID
+ *
+ * @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_JobByJobIdRetry_Response_404 = Problem
+
+/**
+ * 409 response for POST JobByJobIdRetry endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 409 status code
+ * of the POST JobByJobIdRetry endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/job/{job_id}/retry
+ * @param job_id (path) - Job ID
+ *
+ * @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_JobByJobIdRetry_Response_409 = Problem
+
+/**
+ * 422 response for POST JobByJobIdRetry endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST JobByJobIdRetry endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/job/{job_id}/retry
+ * @param job_id (path) - Job ID
+ *
+ * @see {@link POST_JobByJobIdRetry_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_JobByJobIdRetry_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET Jobs endpoint
  *
@@ -10382,6 +10478,87 @@ export type POST_JobsByBatchIdResume_Response_404 = Problem
  */
 export type POST_JobsByBatchIdResume_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST JobsByBatchIdRetry endpoint
+ *
+ * Retry failed and dead-lettered jobs in a batch
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST JobsByBatchIdRetry endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/jobs/{batch_id}/retry
+ * @param batch_id (path) - Batch ID
+ * @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.
+ *
+ * @see {@link POST_JobsByBatchIdRetry_Response_200} - 200 response type
+ * @see {@link POST_JobsByBatchIdRetry_Response_404} - 404 response type
+ * @see {@link POST_JobsByBatchIdRetry_Response_422} - 422 response type
+ *
+
+ */
+export type POST_JobsByBatchIdRetry_Response = POST_JobsByBatchIdRetry_Response_200 | POST_JobsByBatchIdRetry_Response_404 | POST_JobsByBatchIdRetry_Response_422;
+
+/**
+ * 200 response for POST JobsByBatchIdRetry endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST JobsByBatchIdRetry endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/jobs/{batch_id}/retry
+ * @param batch_id (path) - Batch ID
+ * @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.
+ *
+ * @see {@link POST_JobsByBatchIdRetry_Response} - The main response type definition
+ * @see {@link JobBatchRetry} - The actual schema type definition
+ */
+export type POST_JobsByBatchIdRetry_Response_200 = JobBatchRetry
+
+/**
+ * 404 response for POST JobsByBatchIdRetry endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST JobsByBatchIdRetry endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/jobs/{batch_id}/retry
+ * @param batch_id (path) - Batch ID
+ * @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.
+ *
+ * @see {@link POST_JobsByBatchIdRetry_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_JobsByBatchIdRetry_Response_404 = Problem
+
+/**
+ * 422 response for POST JobsByBatchIdRetry endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST JobsByBatchIdRetry endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/jobs/{batch_id}/retry
+ * @param batch_id (path) - Batch ID
+ * @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.
+ *
+ * @see {@link POST_JobsByBatchIdRetry_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_JobsByBatchIdRetry_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET Organizations endpoint
  *

package/src/helpers/schemas.d.ts

@@ -3924,6 +3924,22 @@ export type JobBatchMetadata = components['schemas']['JobBatchMetadataResponse']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type JobBatchRequest = components['schemas']['JobBatchRequest'];
+/**
+ * JobBatchRetryResponse
+ *
+ * @remarks
+ * Type alias for the `JobBatchRetryResponse` OpenAPI schema.
+ * This type represents jobbatchretryresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getJobBatchRetry();
+ * const item: JobBatchRetry = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type JobBatchRetry = components['schemas']['JobBatchRetryResponse'];
 /**
  * JobBatchStatusResponse
  *