asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 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
docs/content/references/js-client/classes/AdminShippingProfilesResource.md
+15 -15
View File
@@ -10,22 +10,22 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostShippingProfilesReq`](internal-22.AdminPostShippingProfilesReq.md) |
| `payload` | [`AdminPostShippingProfilesReq`](internal-24.AdminPostShippingProfilesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\>
#### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12)
[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12)
___
@@ -46,13 +46,13 @@ ___
#### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29)
[medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29)
___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-22.md#adminshippingprofileslistres)\>
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-24.md#adminshippingprofileslistres)\>
#### Parameters
@@ -62,17 +62,17 @@ ___
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-22.md#adminshippingprofileslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-24.md#adminshippingprofileslistres)\>
#### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45)
[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\>
#### Parameters
@@ -83,30 +83,30 @@ ___
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\>
#### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37)
[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-22.AdminPostShippingProfilesProfileReq.md) |
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-24.AdminPostShippingProfilesProfileReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\>
#### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20)
[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20)