Files
medusa-store/www/apps/docs/content/references/js-client/modules/internal-2.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

2.5 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Module: internal

Enumerations

Classes

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

Defined in

packages/medusa/dist/api/routes/admin/batch/index.d.ts:42


AdminBatchJobRes

Ƭ AdminBatchJobRes: Object

Schema

AdminBatchJobRes type: object required:

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

Type declaration

Name Type
batch_job BatchJob

Defined in

packages/medusa/dist/api/routes/admin/batch/index.d.ts:15


BatchJobResultError

Ƭ BatchJobResultError: Object

Index signature

▪ [key: string]: unknown

Type declaration

Name Type
code string | number
message string

Defined in

packages/medusa/dist/types/batch-job.d.ts:18


BatchJobResultStatDescriptor

Ƭ BatchJobResultStatDescriptor: Object

Type declaration

Name Type
key string
message string
name string

Defined in

packages/medusa/dist/types/batch-job.d.ts:23


PaginatedResponse

Ƭ PaginatedResponse: Object

Type declaration

Name Type
count number
limit number
offset number

Defined in

packages/medusa/dist/types/common.d.ts:70