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>
3.7 KiB
3.7 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
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:31
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:47
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:39
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminNotesRes>
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostNotesNoteReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminNotesRes>