Class: AdminBatchJobsResource
Hierarchy
defaultCopy to Clipboard↳
AdminBatchJobsResourceCopy to Clipboard
Methods
cancel
▸ cancel(batchJobIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
batchJobIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/batch-jobs.ts:35
confirm
▸ confirm(batchJobIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
batchJobIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/batch-jobs.ts:43
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostBatchesReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/batch-jobs.ts:13
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminBatchJobListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | AdminGetBatchParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminBatchJobListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/batch-jobs.ts:21
retrieve
▸ retrieve(batchJobIdCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
batchJobIdCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminBatchJobResCopy to Clipboard>