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

chore(docs): Generated JS Client Reference (#5334)

Browse Source 
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>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
www/apps/docs/content/references/js-client/classes/AdminCustomResource.md Normal file
View File

@@ -0,0 +1,99 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCustomResource
## Hierarchy
- `default`
↳ **`AdminCustomResource`**
## Methods
### delete
▸ **delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TResponse` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) |
| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Defined in
[packages/medusa-js/src/resources/admin/custom.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L47)
___
### get
▸ **get**<`TQuery`, `TResponse`\>(`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TQuery` | extends [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `TResponse` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
| `query?` | `TQuery` |
| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) |
| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Defined in
[packages/medusa-js/src/resources/admin/custom.ts:8](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L8)
___
### post
▸ **post**<`TPayload`, `TResponse`\>(`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TPayload` | extends [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `TResponse` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
| `payload?` | `TPayload` |
| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) |
| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Defined in
[packages/medusa-js/src/resources/admin/custom.ts:30](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L30)