internal

Enumerations

• BatchJobStatus

Classes

• AdminGetBatchPaginationParams
• AdminGetBatchParams
• AdminPostBatchesReq
• BatchJob
• DateComparisonOperator

Type Aliases

AdminBatchJobListRes

AdminBatchJobListRes: PaginatedResponse & { batch_jobs: BatchJob[] }

Schema

AdminBatchJobListRes type: object required:

• batch_jobs
• count
• offset
• limit properties: batch_jobs: type: array description: An array of batch job details. items: $ref: "#/components/schemas/BatchJob" count: type: integer description: The total number of items available offset: type: integer description: The number of batch jobs skipped when retrieving the batch jobs. limit: type: integer description: The number of items per page

---

AdminBatchJobRes

AdminBatchJobRes: Object

Schema

AdminBatchJobRes type: object required:

• batch_job properties: batch_job: description: Batch job details. $ref: "#/components/schemas/BatchJob"

Type declaration

batch_jobBatchJobRequired

---

BatchJobResultError

BatchJobResultError: Object

Index signature

▪ [key: string]: unknown

Type declaration

codestring | numberRequired

messagestringRequired

---

BatchJobResultStatDescriptor

BatchJobResultStatDescriptor: Object

Type declaration

keystringRequired

messagestringRequired

namestringRequired

---

PaginatedResponse

PaginatedResponse: Object

Type declaration

countnumberRequired

limitnumberRequired

offsetnumberRequired