Files
medusa-store/docs/content/references/js-client/classes/AdminNotesResource.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: AdminNotesResource

Hierarchy

  • default

    AdminNotesResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminNotesRes>

Parameters

Name Type
payload AdminPostNotesReq
customHeaders Record<string, any>

Returns

ResponsePromise<AdminNotesRes>

Defined in

medusa-js/src/resources/admin/notes.ts:14


delete

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

medusa-js/src/resources/admin/notes.ts:31


list

list(query?, customHeaders?): ResponsePromise<AdminNotesListRes>

Parameters

Name Type
query? AdminGetNotesParams
customHeaders Record<string, any>

Returns

ResponsePromise<AdminNotesListRes>

Defined in

medusa-js/src/resources/admin/notes.ts:47


retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminNotesRes>

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminNotesRes>

Defined in

medusa-js/src/resources/admin/notes.ts:39


update

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

Parameters

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

Returns

ResponsePromise<AdminNotesRes>

Defined in

medusa-js/src/resources/admin/notes.ts:22