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
docs/content/references/js-client/classes/CartsResource.md
+39 -39
View File
@@ -14,13 +14,13 @@
#### Defined in
[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L15)
[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L15)
## Methods
### addShippingMethod
▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Adds a shipping method to cart
@@ -29,22 +29,22 @@ Adds a shipping method to cart
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | Id of cart |
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-30.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data |
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-32.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L24)
[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L24)
___
### complete
▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-30.md#storecompletecartres)\>
▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-32.md#storecompletecartres)\>
Completes a cart.
Payment authorization is attempted and if more work is required, we simply return the cart for further updates.
@@ -61,17 +61,17 @@ If not provuided, we will generate one for the request.
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-30.md#storecompletecartres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-32.md#storecompletecartres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L43)
[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L43)
___
### create
▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Creates a cart
@@ -79,22 +79,22 @@ Creates a cart
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload?` | [`StorePostCartReq`](internal-30.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty |
| `payload?` | [`StorePostCartReq`](internal-32.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L58)
[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L58)
___
### createPaymentSessions
▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Creates payment sessions.
Initializes the payment sessions that can be used to pay for the items of the cart.
@@ -109,17 +109,17 @@ This is usually called when a customer proceeds to checkout.
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L74)
[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L74)
___
### deleteDiscount
▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Removes a discount from cart.
@@ -133,17 +133,17 @@ Removes a discount from cart.
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L89)
[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L89)
___
### deletePaymentSession
▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Removes a payment session from a cart.
Can be useful in case a payment has failed
@@ -158,17 +158,17 @@ Can be useful in case a payment has failed
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L106)
[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L106)
___
### refreshPaymentSession
▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Refreshes a payment session.
@@ -182,17 +182,17 @@ Refreshes a payment session.
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L122)
[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L122)
___
### retrieve
▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Retrieves a cart
@@ -205,17 +205,17 @@ Retrieves a cart
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L137)
[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L137)
___
### setPaymentSession
▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Refreshes a payment session.
@@ -224,22 +224,22 @@ Refreshes a payment session.
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-30.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-32.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L152)
[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L152)
___
### update
▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Updates a cart
@@ -248,22 +248,22 @@ Updates a cart
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `payload` | [`StorePostCartsCartReq`](internal-30.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
| `payload` | [`StorePostCartsCartReq`](internal-32.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L168)
[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L168)
___
### updatePaymentSession
▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
Updates the payment method
@@ -273,13 +273,13 @@ Updates the payment method
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `provider_id` | `string` | is required |
| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-30.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-32.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\>
#### Defined in
[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L185)
[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L185)