daea35fe73
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>
3.6 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminBatchJobsResource
Hierarchy
-
default↳
AdminBatchJobsResource
Methods
cancel
▸ cancel(batchJobId, customHeaders?): ResponsePromise<AdminBatchJobRes>
Parameters
| Name | Type |
|---|---|
batchJobId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminBatchJobRes>
Defined in
packages/medusa-js/src/resources/admin/batch-jobs.ts:35
confirm
▸ confirm(batchJobId, customHeaders?): ResponsePromise<AdminBatchJobRes>
Parameters
| Name | Type |
|---|---|
batchJobId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminBatchJobRes>
Defined in
packages/medusa-js/src/resources/admin/batch-jobs.ts:43
create
▸ create(payload, customHeaders?): ResponsePromise<AdminBatchJobRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostBatchesReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminBatchJobRes>
Defined in
packages/medusa-js/src/resources/admin/batch-jobs.ts:13
list
▸ list(query?, customHeaders?): ResponsePromise<AdminBatchJobListRes>
Parameters
| Name | Type |
|---|---|
query? |
AdminGetBatchParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminBatchJobListRes>
Defined in
packages/medusa-js/src/resources/admin/batch-jobs.ts:21
retrieve
▸ retrieve(batchJobId, customHeaders?): ResponsePromise<AdminBatchJobRes>
Parameters
| Name | Type |
|---|---|
batchJobId |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminBatchJobRes>