Files
medusa-store/docs/content/references/js-client/classes/AdminBatchJobsResource.md
Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994)
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
2022-08-04 17:29:52 +03:00

3.3 KiB

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

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

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

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

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>

Defined in

medusa-js/src/resources/admin/batch-jobs.ts:51