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>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
@@ -1,16 +1,56 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostBatchesReq
[internal](../modules/internal-2.md).AdminPostBatchesReq
**`Schema`**
AdminPostBatchesReq
type: object
required:
- type
- context
properties:
type:
type: string
description: The type of batch job to start, which is defined by the `batchType` property of the associated batch job strategy.
example: product-export
context:
type: object
description: Additional infomration regarding the batch to be used for processing.
example:
shape:
prices:
- region: null
currency_code: "eur"
dynamicImageColumnCount: 4
dynamicOptionColumnCount: 2
list_config:
skip: 0
take: 50
order:
created_at: "DESC"
relations:
- variants
- variant.prices
- images
dry_run:
type: boolean
description: Set a batch job in dry_run mode, which would delay executing the batch job until it's confirmed.
default: false
## Properties
### context
**context**: `Record`<`string`, `unknown`\>
**context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
#### Defined in
medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:100
packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:108
___
@@ -20,7 +60,7 @@ ___
#### Defined in
medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:101
packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:109
___
@@ -30,4 +70,4 @@ ___
#### Defined in
medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:99
packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:107