02d5c1da88
* 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
114 lines
3.3 KiB
Markdown
114 lines
3.3 KiB
Markdown
# Class: AdminNotesResource
|
|
|
|
## Hierarchy
|
|
|
|
- `default`
|
|
|
|
↳ **`AdminNotesResource`**
|
|
|
|
## Methods
|
|
|
|
### create
|
|
|
|
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `payload` | [`AdminPostNotesReq`](internal-10.AdminPostNotesReq.md) |
|
|
| `customHeaders` | `Record`<`string`, `any`\> |
|
|
|
|
#### Returns
|
|
|
|
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
|
|
|
#### Defined in
|
|
|
|
[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L14)
|
|
|
|
___
|
|
|
|
### delete
|
|
|
|
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `id` | `string` |
|
|
| `customHeaders` | `Record`<`string`, `any`\> |
|
|
|
|
#### Returns
|
|
|
|
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
|
|
|
#### Defined in
|
|
|
|
[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L31)
|
|
|
|
___
|
|
|
|
### list
|
|
|
|
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\>
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `query?` | [`AdminGetNotesParams`](internal-10.AdminGetNotesParams.md) |
|
|
| `customHeaders` | `Record`<`string`, `any`\> |
|
|
|
|
#### Returns
|
|
|
|
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\>
|
|
|
|
#### Defined in
|
|
|
|
[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L47)
|
|
|
|
___
|
|
|
|
### retrieve
|
|
|
|
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `id` | `string` |
|
|
| `customHeaders` | `Record`<`string`, `any`\> |
|
|
|
|
#### Returns
|
|
|
|
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
|
|
|
#### Defined in
|
|
|
|
[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L39)
|
|
|
|
___
|
|
|
|
### update
|
|
|
|
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `id` | `string` |
|
|
| `payload` | [`AdminPostNotesNoteReq`](internal-10.AdminPostNotesNoteReq.md) |
|
|
| `customHeaders` | `Record`<`string`, `any`\> |
|
|
|
|
#### Returns
|
|
|
|
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
|
|
|
#### Defined in
|
|
|
|
[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L22)
|