3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
3.4 KiB
3.4 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
packages/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
packages/medusa-js/src/resources/admin/notes.ts:27
list
▸ list(query?, customHeaders?): ResponsePromise<AdminNotesListRes>
Parameters
| Name | Type |
|---|---|
query? |
AdminGetNotesParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminNotesListRes>
Defined in
packages/medusa-js/src/resources/admin/notes.ts:37
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminNotesRes>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminNotesRes>
Defined in
packages/medusa-js/src/resources/admin/notes.ts:32
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminNotesRes>
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostNotesNoteReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminNotesRes>