Files
medusa-store/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.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

3.4 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AdminPaymentCollectionsResource

Hierarchy

  • default

    AdminPaymentCollectionsResource

Methods

delete

delete(id, customHeaders?): ResponsePromise<AdminPaymentCollectionDeleteRes>

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminPaymentCollectionDeleteRes>

Defined in

packages/medusa-js/src/resources/admin/payment-collections.ts:36


markAsAuthorized

markAsAuthorized(id, customHeaders?): ResponsePromise<AdminPaymentCollectionsRes>

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminPaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/admin/payment-collections.ts:44


retrieve

retrieve(id, query?, customHeaders?): ResponsePromise<AdminPaymentCollectionsRes>

Parameters

Name Type
id string
query? AdminGetPaymentCollectionsParams
customHeaders Record<string, any>

Returns

ResponsePromise<AdminPaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/admin/payment-collections.ts:12


update

update(id, payload, customHeaders?): ResponsePromise<AdminPaymentCollectionsRes>

Parameters

Name Type
id string
payload AdminUpdatePaymentCollectionsReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminPaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/admin/payment-collections.ts:27