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

docs: added reference for JS Client (#1629)

Browse Source 
* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
This commit is contained in:
Shahed Nasser
2022-07-08 18:21:46 +03:00
committed by GitHub
parent 371682b4f7
commit 3b28f46705
357 changed files with 32911 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
docs/content/references/js-client/classes/AdminShippingProfilesResource.md Normal file
View File

@@ -0,0 +1,112 @@
# Class: AdminShippingProfilesResource
## Hierarchy
- `default`
↳ **`AdminShippingProfilesResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostShippingProfilesReq`](internal.AdminPostShippingProfilesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L27)
___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L32)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal.AdminPostShippingProfilesProfileReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L19)