asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: updated js client reference (#2414)

Browse Source 
* docs: updated js client reference

* docs: fixed link
This commit is contained in:
Shahed Nasser
2022-10-11 16:32:41 +03:00
committed by GitHub
parent b3ebc78b95
commit 8ca9354c50
384 changed files with 5705 additions and 4184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/content/references/js-client/classes/AdminNotesResource.md
View File

@@ -10,22 +10,22 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostNotesReq`](internal-10.AdminPostNotesReq.md) |
| `payload` | [`AdminPostNotesReq`](internal-11.AdminPostNotesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\>
#### Defined in
[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L14)
[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L14)
___
@@ -46,34 +46,34 @@ ___
#### Defined in
[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L31)
[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L31)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\>
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetNotesParams`](internal-10.AdminGetNotesParams.md) |
| `query?` | [`AdminGetNotesParams`](internal-11.AdminGetNotesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\>
#### Defined in
[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L47)
[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L47)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\>
#### Parameters
@@ -84,30 +84,30 @@ ___
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\>
#### Defined in
[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L39)
[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/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)\>
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostNotesNoteReq`](internal-10.AdminPostNotesNoteReq.md) |
| `payload` | [`AdminPostNotesNoteReq`](internal-11.AdminPostNotesNoteReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\>
#### Defined in
[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L22)
[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L22)