docs: migrate guides to TSDoc references (#6100)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
85dad169bb
commit
4792c55226
980 files changed
+195537
-160619
No files matched your search
+3
-15
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates an analytics config.
|
||||
@@ -62,9 +60,7 @@ Creates an analytics config.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)>","optional":false,"defaultValue":"","description":"Creates an analytics config.","expandable":false,"children":[]}]} />
|
||||
|
||||
### delete
|
||||
|
||||
@@ -76,9 +72,7 @@ Deletes an analytics config.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Deletes an analytics config.","expandable":false,"children":[]}]} />
|
||||
|
||||
### retrieve
|
||||
|
||||
@@ -90,8 +84,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -102,8 +94,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates an analytics config. If the config does not exist, it will be created instead.
|
||||
@@ -114,9 +104,7 @@ Updates an analytics config. If the config does not exist, it will be created in
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[AnalyticsConfig](../../entities/classes/entities.AnalyticsConfig.mdx)>","optional":false,"defaultValue":"","description":"Updates an analytics config. If the config does not exist, it will be created instead.","expandable":false,"children":[]}]} />
|
||||
|
||||
### withTransaction
|
||||
|
||||
|
||||
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### authenticate
|
||||
|
||||
Authenticates a given user based on an email, password combination. Uses
|
||||
@@ -67,8 +65,6 @@ scrypt to match password with hashed value.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<AuthenticateResult>","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### authenticateAPIToken
|
||||
|
||||
Authenticates a given user with an API token
|
||||
@@ -81,8 +77,6 @@ Authenticates a given user with an API token
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<AuthenticateResult>","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n user: the user document if authentication succeeded\n error: a string with the error message","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### authenticateCustomer
|
||||
|
||||
Authenticates a customer based on an email, password combination. Uses
|
||||
@@ -96,8 +90,6 @@ scrypt to match password with hashed value.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<AuthenticateResult>","optional":false,"defaultValue":"","description":"success: whether authentication succeeded\n customer: the customer document if authentication succeded\n error: a string with the error message","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### comparePassword\_
|
||||
|
||||
Verifies if a password is valid given the provided password hash
|
||||
@@ -110,8 +102,6 @@ Verifies if a password is valid given the provided password hash
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"the result of the comparison","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -122,8 +112,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### complete
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### confirm
|
||||
|
||||
#### Parameters
|
||||
@@ -86,8 +80,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -98,8 +90,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -110,8 +100,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[BatchJob](../../entities/classes/entities.BatchJob.mdx)[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### prepareBatchJobForProcessing
|
||||
|
||||
#### Parameters
|
||||
@@ -122,8 +110,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
#### Parameters
|
||||
@@ -134,8 +120,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setFailed
|
||||
|
||||
#### Parameters
|
||||
@@ -146,8 +130,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setPreProcessingDone
|
||||
|
||||
#### Parameters
|
||||
@@ -158,8 +140,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setProcessing
|
||||
|
||||
#### Parameters
|
||||
@@ -170,8 +150,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -182,8 +160,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -194,8 +170,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateStatus
|
||||
|
||||
#### Parameters
|
||||
@@ -206,8 +180,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[BatchJob](../../entities/classes/entities.BatchJob.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -48,8 +48,6 @@ Adds a line item to the cart.
|
||||
|
||||
Use [addOrUpdateLineItems](services.CartService.mdx#addorupdatelineitems) instead.
|
||||
|
||||
___
|
||||
|
||||
### addOrUpdateLineItems
|
||||
|
||||
Adds or update one or multiple line items to the cart. It also update all existing items in the cart
|
||||
@@ -63,8 +61,6 @@ to have has\_shipping to false. Finally, the adjustments will be updated.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addShippingMethod
|
||||
|
||||
Adds the shipping method to the list of shipping methods associated with
|
||||
@@ -81,8 +77,6 @@ shop.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### adjustFreeShipping\_
|
||||
|
||||
Ensures shipping total on cart is correct in regards to a potential free
|
||||
@@ -98,8 +92,6 @@ if a free shipping was present, we set shipping methods to original amount
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"void","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### applyDiscount
|
||||
|
||||
Updates the cart's discounts.
|
||||
@@ -113,9 +105,7 @@ Throws if discount regions does not include the cart region
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Updates the cart's discounts.\nIf discount besides free shipping is already applied, this\nwill be overwritten\nThrows if discount regions does not include the cart region","expandable":false,"children":[]}]} />
|
||||
|
||||
### applyDiscounts
|
||||
|
||||
@@ -130,9 +120,7 @@ Throws if discount regions does not include the cart region
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Updates the cart's discounts.\nIf discount besides free shipping is already applied, this\nwill be overwritten\nThrows if discount regions does not include the cart region","expandable":false,"children":[]}]} />
|
||||
|
||||
### applyGiftCard\_
|
||||
|
||||
@@ -144,8 +132,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -164,8 +150,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### authorizePayment
|
||||
|
||||
Authorizes a payment for a cart.
|
||||
@@ -182,8 +166,6 @@ set the payment on the cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the resulting cart","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a cart.
|
||||
@@ -196,8 +178,6 @@ Creates a cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createOrFetchGuestCustomerFromEmail\_
|
||||
|
||||
Creates or fetches a user based on an email.
|
||||
@@ -210,8 +190,6 @@ Creates or fetches a user based on an email.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"the resultign customer object","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createTaxLines
|
||||
|
||||
#### Parameters
|
||||
@@ -222,8 +200,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### decorateTotals
|
||||
|
||||
#### Parameters
|
||||
@@ -234,8 +210,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[WithRequiredProperty](../../medusa/types/medusa.WithRequiredProperty.mdx)<[Cart](../../entities/classes/entities.Cart.mdx), \"total\">>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### decorateTotals\_
|
||||
|
||||
#### Parameters
|
||||
@@ -250,8 +224,6 @@ ___
|
||||
|
||||
Use decorateTotals instead
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a cart from the database. Completed carts cannot be deleted.
|
||||
@@ -264,8 +236,6 @@ Deletes a cart from the database. Completed carts cannot be deleted.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the deleted cart or undefined if the cart was not found.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deletePaymentSession
|
||||
|
||||
Removes a payment session from the cart.
|
||||
@@ -278,8 +248,6 @@ Removes a payment session from the cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the resulting cart.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteTaxLines
|
||||
|
||||
#### Parameters
|
||||
@@ -290,8 +258,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### findCustomShippingOption
|
||||
|
||||
Finds the cart's custom shipping options based on the passed option id.
|
||||
@@ -305,8 +271,6 @@ throws if custom options is not empty and no shipping option corresponds to opti
|
||||
|
||||
<ParameterTypes parameters={[{"name":"undefined \\| CustomShippingOption","type":"`undefined` \\| [CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)","optional":false,"defaultValue":"","description":"custom shipping option","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getTotalsRelations
|
||||
|
||||
#### Parameters
|
||||
@@ -317,8 +281,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getValidatedSalesChannel
|
||||
|
||||
#### Parameters
|
||||
@@ -329,8 +291,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -341,8 +301,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### onSalesChannelChange
|
||||
|
||||
Remove the cart line item that does not belongs to the newly assigned sales channel
|
||||
@@ -355,8 +313,6 @@ Remove the cart line item that does not belongs to the newly assigned sales chan
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"void","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refreshAdjustments\_
|
||||
|
||||
#### Parameters
|
||||
@@ -367,8 +323,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refreshPaymentSession
|
||||
|
||||
Refreshes a payment session on a cart
|
||||
@@ -381,8 +335,6 @@ Refreshes a payment session on a cart
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the resulting cart.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeDiscount
|
||||
|
||||
Removes a discount based on a discount code.
|
||||
@@ -395,8 +347,6 @@ Removes a discount based on a discount code.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the resulting cart","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeLineItem
|
||||
|
||||
Removes a line item from the cart.
|
||||
@@ -409,8 +359,6 @@ Removes a line item from the cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a cart by id.
|
||||
@@ -423,8 +371,6 @@ Gets a cart by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the cart document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveLegacy
|
||||
|
||||
#### Parameters
|
||||
@@ -437,8 +383,6 @@ ___
|
||||
|
||||
#### Deprecated
|
||||
|
||||
___
|
||||
|
||||
### retrieveWithTotals
|
||||
|
||||
#### Parameters
|
||||
@@ -449,8 +393,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[WithRequiredProperty](../../medusa/types/medusa.WithRequiredProperty.mdx)<[Cart](../../entities/classes/entities.Cart.mdx), \"total\">>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setMetadata
|
||||
|
||||
Dedicated method to set metadata for a cart.
|
||||
@@ -465,8 +407,6 @@ others metadata fields, setMetadata is provided.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"resolves to the updated result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setPaymentSession
|
||||
|
||||
Selects a payment session for a cart and creates a payment object in the external provider system
|
||||
@@ -477,9 +417,7 @@ Selects a payment session for a cart and creates a payment object in the externa
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Selects a payment session for a cart and creates a payment object in the external provider system","expandable":false,"children":[]}]} />
|
||||
|
||||
### setPaymentSessions
|
||||
|
||||
@@ -497,8 +435,6 @@ that are not available for the cart's region.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setRegion\_
|
||||
|
||||
Set's the region of a cart.
|
||||
@@ -511,8 +447,6 @@ Set's the region of a cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -523,8 +457,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### transformQueryForTotals\_
|
||||
|
||||
#### Parameters
|
||||
@@ -535,8 +467,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"FindConfig","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"totalsToSelect","type":"[TotalField](../../medusa/types/medusa.TotalField.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -547,8 +477,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateBillingAddress\_
|
||||
|
||||
Updates the cart's billing address.
|
||||
@@ -561,8 +489,6 @@ Updates the cart's billing address.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateCustomerId\_
|
||||
|
||||
Sets the customer id of a cart
|
||||
@@ -575,8 +501,6 @@ Sets the customer id of a cart
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateLineItem
|
||||
|
||||
Updates a cart's existing line item.
|
||||
@@ -589,8 +513,6 @@ Updates a cart's existing line item.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updatePaymentSession
|
||||
|
||||
Updates the currently selected payment session.
|
||||
@@ -603,8 +525,6 @@ Updates the currently selected payment session.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Cart](../../entities/classes/entities.Cart.mdx)>","optional":false,"defaultValue":"","description":"the resulting cart","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateShippingAddress\_
|
||||
|
||||
Updates the cart's shipping address.
|
||||
@@ -617,8 +537,6 @@ Updates the cart's shipping address.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateUnitPrices\_
|
||||
|
||||
#### Parameters
|
||||
@@ -629,8 +547,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateLineItem
|
||||
|
||||
Check if line item's variant belongs to the cart's sales channel.
|
||||
@@ -643,8 +559,6 @@ Check if line item's variant belongs to the cart's sales channel.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"a boolean indicating validation result","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateLineItemShipping\_
|
||||
|
||||
Checks if a given line item has a shipping method that can fulfill it.
|
||||
@@ -659,8 +573,6 @@ shipping methods.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"boolean representing whether shipping method is validated","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a claim item by id.
|
||||
@@ -88,8 +82,6 @@ Gets a claim item by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)>","optional":false,"defaultValue":"","description":"the ClaimItem","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -100,8 +92,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -112,8 +102,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a Claim on an Order. Claims consists of items that are claimed and
|
||||
@@ -90,8 +84,6 @@ shipping address that the new items will be shipped to
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"created claim","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
#### Parameters
|
||||
@@ -102,8 +94,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"created claim","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createShipment
|
||||
|
||||
#### Parameters
|
||||
@@ -114,8 +104,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getRefundTotalForClaimLinesOnOrder
|
||||
|
||||
Finds claim line items on an order and calculates the refund amount.
|
||||
@@ -133,8 +121,6 @@ Note, it will attempt to return early from each of these places to avoid having
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the refund amount","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -145,8 +131,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### processRefund
|
||||
|
||||
#### Parameters
|
||||
@@ -157,8 +141,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets an order by id.
|
||||
@@ -171,8 +153,6 @@ Gets an order by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"the order document","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -183,8 +163,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -195,8 +173,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateCreateClaimInput
|
||||
|
||||
#### Parameters
|
||||
@@ -207,8 +183,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists currencies based on the provided parameters and includes the count of
|
||||
@@ -65,8 +63,6 @@ currencies that match the query.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Currency](../../entities/classes/entities.Currency.mdx)[], number]>","optional":false,"defaultValue":"","description":"an array containing the currencies as\n the first element and the total count of products that matches the query\n as the second element.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCode
|
||||
|
||||
Return the currency
|
||||
@@ -79,8 +75,6 @@ Return the currency
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Currency](../../entities/classes/entities.Currency.mdx)>","optional":false,"defaultValue":"","description":"The currency","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -91,8 +85,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Update a currency
|
||||
@@ -105,8 +97,6 @@ Update a currency
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| [Currency](../../entities/classes/entities.Currency.mdx)>","optional":false,"defaultValue":"","description":"The updated currency","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-10
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a custom shipping option
|
||||
@@ -68,8 +66,6 @@ Creates a custom shipping option
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"resolves to the creation result","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Fetches all custom shipping options based on the given selector
|
||||
@@ -82,8 +78,6 @@ Fetches all custom shipping options based on the given selector
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)[]>","optional":false,"defaultValue":"","description":"custom shipping options matching the query","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a specific shipping option.
|
||||
@@ -96,8 +90,6 @@ Retrieves a specific shipping option.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomShippingOption](../../entities/classes/entities.CustomShippingOption.mdx)>","optional":false,"defaultValue":"","description":"the requested custom shipping option.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -108,8 +100,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -44,8 +44,6 @@ Add a batch of customers to a customer group at once
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)>","optional":false,"defaultValue":"","description":"the customer group after insertion","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -64,8 +62,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a customer group with the provided data.
|
||||
@@ -78,8 +74,6 @@ Creates a customer group with the provided data.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)>","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Remove customer group
|
||||
@@ -92,8 +86,6 @@ Remove customer group
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"a promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### handleCreationFail
|
||||
|
||||
#### Parameters
|
||||
@@ -104,8 +96,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<never>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
List customer groups.
|
||||
@@ -118,8 +108,6 @@ List customer groups.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Retrieve a list of customer groups and total count of records that match the query.
|
||||
@@ -132,8 +120,6 @@ Retrieve a list of customer groups and total count of records that match the que
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeCustomer
|
||||
|
||||
Remove list of customers from a customergroup
|
||||
@@ -146,8 +132,6 @@ Remove list of customers from a customergroup
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)>","optional":false,"defaultValue":"","description":"the customergroup with the provided id","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
#### Parameters
|
||||
@@ -158,8 +142,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -170,8 +152,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Update a customer group.
|
||||
@@ -184,8 +164,6 @@ Update a customer group.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)>","optional":false,"defaultValue":"","description":"resulting customer group","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -44,8 +44,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx) \\| [Address](../../entities/classes/entities.Address.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -64,8 +62,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### count
|
||||
|
||||
Return the total number of documents in database
|
||||
@@ -74,8 +70,6 @@ Return the total number of documents in database
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the result of the count operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a customer from an email - customers can have accounts associated,
|
||||
@@ -91,8 +85,6 @@ used to hold details of customers.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"the result of create","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a customer from a given customer id.
|
||||
@@ -105,8 +97,6 @@ Deletes a customer from a given customer id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"the result of the delete operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### generateResetPasswordToken
|
||||
|
||||
Generate a JSON Web token, that will be sent to a customer, that wishes to
|
||||
@@ -123,8 +113,6 @@ which is always 15 minutes.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"the generated JSON web token","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### hashPassword\_
|
||||
|
||||
Hashes a password
|
||||
@@ -137,8 +125,6 @@ Hashes a password
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"hashed password","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -149,8 +135,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -161,8 +145,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Customer](../../entities/classes/entities.Customer.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listByEmail
|
||||
|
||||
#### Parameters
|
||||
@@ -173,8 +155,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeAddress
|
||||
|
||||
#### Parameters
|
||||
@@ -185,8 +165,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a customer by id.
|
||||
@@ -199,8 +177,6 @@ Gets a customer by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"the customer document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByEmail
|
||||
|
||||
Gets a registered customer by email.
|
||||
@@ -215,8 +191,6 @@ Gets a registered customer by email.
|
||||
|
||||
#### Deprecated
|
||||
|
||||
___
|
||||
|
||||
### retrieveByPhone
|
||||
|
||||
Gets a customer by phone.
|
||||
@@ -229,8 +203,6 @@ Gets a customer by phone.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"the customer document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveRegisteredByEmail
|
||||
|
||||
#### Parameters
|
||||
@@ -241,8 +213,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveUnregisteredByEmail
|
||||
|
||||
#### Parameters
|
||||
@@ -253,8 +223,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve\_
|
||||
|
||||
#### Parameters
|
||||
@@ -265,8 +233,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -277,8 +243,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a customer.
|
||||
@@ -291,8 +255,6 @@ Updates a customer.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Customer](../../entities/classes/entities.Customer.mdx)>","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateAddress
|
||||
|
||||
#### Parameters
|
||||
@@ -303,8 +265,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Address](../../entities/classes/entities.Address.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateBillingAddress\_
|
||||
|
||||
Updates the customers' billing address.
|
||||
@@ -317,8 +277,6 @@ Updates the customers' billing address.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-14
@@ -54,8 +54,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
@@ -66,8 +64,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeResources
|
||||
|
||||
#### Parameters
|
||||
@@ -78,8 +74,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
#### Parameters
|
||||
@@ -90,8 +84,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -102,8 +94,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### upsertCondition
|
||||
|
||||
#### Parameters
|
||||
@@ -114,8 +104,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<([DiscountConditionProduct](../../entities/classes/entities.DiscountConditionProduct.mdx) \\| [DiscountConditionProductType](../../entities/classes/entities.DiscountConditionProductType.mdx) \\| [DiscountConditionProductCollection](../../entities/classes/entities.DiscountConditionProductCollection.mdx) \\| [DiscountConditionProductTag](../../entities/classes/entities.DiscountConditionProductTag.mdx) \\| [DiscountConditionCustomerGroup](../../entities/classes/entities.DiscountConditionCustomerGroup.mdx))[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
@@ -126,8 +114,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### resolveConditionType\_
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -48,8 +48,6 @@ Adds a region to the discount regions array.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -68,8 +66,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### calculateDiscountForLineItem
|
||||
|
||||
#### Parameters
|
||||
@@ -80,8 +76,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### canApplyForCustomer
|
||||
|
||||
#### Parameters
|
||||
@@ -92,8 +86,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a discount with provided data given that the data is validated.
|
||||
@@ -107,8 +99,6 @@ Normalizes discount code to uppercase.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)>","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createDynamicCode
|
||||
|
||||
Creates a dynamic code for a discount id.
|
||||
@@ -121,8 +111,6 @@ Creates a dynamic code for a discount id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)>","optional":false,"defaultValue":"","description":"the newly created dynamic code","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a discount idempotently
|
||||
@@ -135,8 +123,6 @@ Deletes a discount idempotently
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteDynamicCode
|
||||
|
||||
Deletes a dynamic code for a discount id.
|
||||
@@ -149,8 +135,6 @@ Deletes a dynamic code for a discount id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the newly created dynamic code","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### hasCustomersGroupCondition
|
||||
|
||||
#### Parameters
|
||||
@@ -161,8 +145,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### hasExpired
|
||||
|
||||
#### Parameters
|
||||
@@ -173,8 +155,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### hasNotStarted
|
||||
|
||||
#### Parameters
|
||||
@@ -185,8 +165,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### hasReachedLimit
|
||||
|
||||
#### Parameters
|
||||
@@ -197,8 +175,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### isDisabled
|
||||
|
||||
#### Parameters
|
||||
@@ -209,8 +185,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### isValidForRegion
|
||||
|
||||
#### Parameters
|
||||
@@ -221,8 +195,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -233,8 +205,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -245,8 +215,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Discount](../../entities/classes/entities.Discount.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listByCodes
|
||||
|
||||
List all the discounts corresponding to the given codes
|
||||
@@ -259,8 +227,6 @@ List all the discounts corresponding to the given codes
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)[]>","optional":false,"defaultValue":"","description":"the discounts","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeRegion
|
||||
|
||||
Removes a region from the discount regions array.
|
||||
@@ -273,8 +239,6 @@ Removes a region from the discount regions array.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a discount by id.
|
||||
@@ -287,8 +251,6 @@ Gets a discount by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)>","optional":false,"defaultValue":"","description":"the discount","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCode
|
||||
|
||||
Gets the discount by discount code.
|
||||
@@ -301,8 +263,6 @@ Gets the discount by discount code.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)>","optional":false,"defaultValue":"","description":"the discount","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -313,8 +273,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a discount.
|
||||
@@ -327,8 +285,6 @@ Updates a discount.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Discount](../../entities/classes/entities.Discount.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateDiscountForCartOrThrow
|
||||
|
||||
#### Parameters
|
||||
@@ -339,8 +295,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateDiscountForProduct
|
||||
|
||||
#### Parameters
|
||||
@@ -351,8 +305,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateDiscountRule\_
|
||||
|
||||
Creates a discount rule with provided data given that the data is validated.
|
||||
@@ -369,8 +321,6 @@ Creates a discount rule with provided data given that the data is validated.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -54,8 +54,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a draft order.
|
||||
@@ -68,8 +66,6 @@ Creates a draft order.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)>","optional":false,"defaultValue":"","description":"the created draft order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes draft order idempotently.
|
||||
@@ -82,8 +78,6 @@ Deletes draft order idempotently.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| [DraftOrder](../../entities/classes/entities.DraftOrder.mdx)>","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Lists draft orders
|
||||
@@ -96,8 +90,6 @@ Lists draft orders
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)[]>","optional":false,"defaultValue":"","description":"list of draft orders","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists draft orders alongside the count
|
||||
@@ -110,8 +102,6 @@ Lists draft orders alongside the count
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)[], number]>","optional":false,"defaultValue":"","description":"draft orders","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerCartCompletion
|
||||
|
||||
Registers a draft order as completed, when an order has been completed.
|
||||
@@ -124,8 +114,6 @@ Registers a draft order as completed, when an order has been completed.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<UpdateResult>","optional":false,"defaultValue":"","description":"the created order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a draft order with the given id.
|
||||
@@ -138,8 +126,6 @@ Retrieves a draft order with the given id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)>","optional":false,"defaultValue":"","description":"the draft order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartId
|
||||
|
||||
Retrieves a draft order based on its associated cart id
|
||||
@@ -152,8 +138,6 @@ Retrieves a draft order based on its associated cart id
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)>","optional":false,"defaultValue":"","description":"the draft order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -164,8 +148,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a draft order with the given data
|
||||
@@ -178,8 +160,6 @@ Updates a draft order with the given data
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)>","optional":false,"defaultValue":"","description":"the updated draft order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -19,7 +19,7 @@ ___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config_","type":"[ConfigModule](../../medusa/types/medusa.ConfigModule-1.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"enqueue_","type":"Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"logger_","type":"[Logger](../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldEnqueuerRun","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stagedJobService_","type":"[StagedJobService](services.StagedJobService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config_","type":"[ConfigModule](../../medusa/interfaces/medusa.ConfigModule-1.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"enqueue_","type":"Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"logger_","type":"[Logger](../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldEnqueuerRun","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stagedJobService_","type":"[StagedJobService](services.StagedJobService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
@@ -31,8 +31,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### eventBusModuleService\_
|
||||
|
||||
#### Returns
|
||||
@@ -61,8 +59,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### emit
|
||||
|
||||
`**emit**<TypeParameter T>(data): Promise<void \| [StagedJob](../../entities/classes/entities.StagedJob.mdx)[]>`
|
||||
@@ -97,16 +93,12 @@ Calls all subscribers when an event occurs.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)>","optional":false,"defaultValue":"","description":"the job from our queue","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### enqueuer\_
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listJobs
|
||||
|
||||
#### Parameters
|
||||
@@ -117,8 +109,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<never[] \\| [StagedJob](../../entities/classes/entities.StagedJob.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -129,24 +119,18 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### startEnqueuer
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### stopEnqueuer
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### subscribe
|
||||
|
||||
Adds a function to a list of event subscribers.
|
||||
@@ -159,8 +143,6 @@ Adds a function to a list of event subscribers.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"this","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### unsubscribe
|
||||
|
||||
Removes function from the list of event subscribers.
|
||||
@@ -173,8 +155,6 @@ Removes function from the list of event subscribers.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"this","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-28
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### calculatePrice
|
||||
|
||||
#### Parameters
|
||||
@@ -64,8 +62,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### canCalculate
|
||||
|
||||
#### Parameters
|
||||
@@ -76,8 +72,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
#### Parameters
|
||||
@@ -88,8 +82,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
#### Parameters
|
||||
@@ -100,8 +92,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createReturn
|
||||
|
||||
#### Parameters
|
||||
@@ -112,16 +102,12 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listFulfillmentOptions
|
||||
|
||||
#### Parameters
|
||||
@@ -132,8 +118,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<FulfillmentOptions[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerInstalledProviders
|
||||
|
||||
#### Parameters
|
||||
@@ -144,8 +128,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveDocuments
|
||||
|
||||
Fetches documents from the fulfillment provider
|
||||
@@ -158,8 +140,6 @@ Fetches documents from the fulfillment provider
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<any>","optional":false,"defaultValue":"","description":"document to fetch","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveProvider
|
||||
|
||||
#### Parameters
|
||||
@@ -170,8 +150,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"the payment fulfillment provider","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -182,8 +160,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateFulfillmentData
|
||||
|
||||
#### Parameters
|
||||
@@ -194,8 +170,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateOption
|
||||
|
||||
#### Parameters
|
||||
@@ -206,8 +180,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
Cancels a fulfillment with the fulfillment provider. Will decrement the
|
||||
@@ -68,8 +66,6 @@ Throws if the fulfillment has already been shipped.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)>","optional":false,"defaultValue":"","description":"the result of the save operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
Creates an order fulfillment
|
||||
@@ -85,8 +81,6 @@ those partitions.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]>","optional":false,"defaultValue":"","description":"the created fulfillments","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createShipment
|
||||
|
||||
Creates a shipment by marking a fulfillment as shipped. Adds
|
||||
@@ -100,8 +94,6 @@ tracking links and potentially more metadata.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)>","optional":false,"defaultValue":"","description":"the shipped fulfillment","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getFulfillmentItems\_
|
||||
|
||||
Retrieves the order line items, given an array of items.
|
||||
@@ -114,8 +106,6 @@ Retrieves the order line items, given an array of items.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<(null \\| [LineItem](../../entities/classes/entities.LineItem.mdx))[]>","optional":false,"defaultValue":"","description":"the line items generated by the transformer.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### partitionItems\_
|
||||
|
||||
#### Parameters
|
||||
@@ -126,8 +116,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"FulfillmentItemPartition[]","type":"`FulfillmentItemPartition`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a fulfillment by its id.
|
||||
@@ -140,8 +128,6 @@ Retrieves a fulfillment by its id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)>","optional":false,"defaultValue":"","description":"the fulfillment","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -152,8 +138,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateFulfillmentLineItem\_
|
||||
|
||||
Checks that a given quantity of a line item can be fulfilled. Fails if the
|
||||
@@ -169,8 +153,6 @@ quantity from the quantity that was originally purchased.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"null \\| LineItem","type":"`null` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)","optional":false,"defaultValue":"","description":"a line item that has the requested fulfillment quantity\n set.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a gift card with provided data given that the data is validated.
|
||||
@@ -66,8 +64,6 @@ Creates a gift card with provided data given that the data is validated.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[GiftCard](../../entities/classes/entities.GiftCard.mdx)>","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createTransaction
|
||||
|
||||
#### Parameters
|
||||
@@ -78,8 +74,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a gift card idempotently
|
||||
@@ -92,8 +86,6 @@ Deletes a gift card idempotently
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [GiftCard](../../entities/classes/entities.GiftCard.mdx)>","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -104,8 +96,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -116,8 +106,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[GiftCard](../../entities/classes/entities.GiftCard.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a gift card by id.
|
||||
@@ -130,8 +118,6 @@ Gets a gift card by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[GiftCard](../../entities/classes/entities.GiftCard.mdx)>","optional":false,"defaultValue":"","description":"the gift card","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCode
|
||||
|
||||
#### Parameters
|
||||
@@ -142,8 +128,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[GiftCard](../../entities/classes/entities.GiftCard.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve\_
|
||||
|
||||
#### Parameters
|
||||
@@ -154,8 +138,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[GiftCard](../../entities/classes/entities.GiftCard.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -166,8 +148,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a giftCard.
|
||||
@@ -180,8 +160,6 @@ Updates a giftCard.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[GiftCard](../../entities/classes/entities.GiftCard.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
@@ -192,8 +170,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### generateCode
|
||||
|
||||
Generates a 16 character gift card code
|
||||
@@ -202,8 +178,6 @@ Generates a 16 character gift card code
|
||||
|
||||
<ParameterTypes parameters={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"the generated gift card code","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### resolveTaxRate
|
||||
|
||||
The tax\_rate of the giftcard can depend on whether regions tax gift cards, an input
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates an idempotency key for a request.
|
||||
@@ -66,8 +64,6 @@ identifier.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)>","optional":false,"defaultValue":"","description":"the created idempotency key","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### initializeRequest
|
||||
|
||||
Execute the initial steps in a idempotent request.
|
||||
@@ -80,8 +76,6 @@ Execute the initial steps in a idempotent request.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)>","optional":false,"defaultValue":"","description":"the existing or created idempotency key","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### lock
|
||||
|
||||
Locks an idempotency.
|
||||
@@ -94,8 +88,6 @@ Locks an idempotency.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)>","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves an idempotency key
|
||||
@@ -108,8 +100,6 @@ Retrieves an idempotency key
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)>","optional":false,"defaultValue":"","description":"idempotency key","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -120,8 +110,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Locks an idempotency.
|
||||
@@ -134,8 +122,6 @@ Locks an idempotency.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)>","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
@@ -146,8 +132,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### workStage
|
||||
|
||||
Performs an atomic work stage.
|
||||
|
||||
-20
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a line item adjustment
|
||||
@@ -66,8 +64,6 @@ Creates a line item adjustment
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)>","optional":false,"defaultValue":"","description":"line item adjustment","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createAdjustmentForLineItem
|
||||
|
||||
Creates adjustment for a line item
|
||||
@@ -80,8 +76,6 @@ Creates adjustment for a line item
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]>","optional":false,"defaultValue":"","description":"a line item adjustment or undefined if no adjustment was created","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createAdjustments
|
||||
|
||||
Creates adjustment for a line item
|
||||
@@ -94,8 +88,6 @@ Creates adjustment for a line item
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[] \\| [LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[][]>","optional":false,"defaultValue":"","description":"if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created\notherwise returns an array of line item adjustments for each line item in the cart","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes line item adjustments matching a selector
|
||||
@@ -108,8 +100,6 @@ Deletes line item adjustments matching a selector
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### generateAdjustments
|
||||
|
||||
Creates adjustment for a line item
|
||||
@@ -122,8 +112,6 @@ Creates adjustment for a line item
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<GeneratedAdjustment[]>","optional":false,"defaultValue":"","description":"a line item adjustment or undefined if no adjustment was created","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Lists line item adjustments
|
||||
@@ -136,8 +124,6 @@ Lists line item adjustments
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a line item adjustment by id.
|
||||
@@ -150,8 +136,6 @@ Retrieves a line item adjustment by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)>","optional":false,"defaultValue":"","description":"the line item adjustment.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -162,8 +146,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Creates a line item adjustment
|
||||
@@ -176,8 +158,6 @@ Creates a line item adjustment
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)>","optional":false,"defaultValue":"","description":"line item adjustment","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cloneTo
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Create a line item
|
||||
@@ -80,8 +76,6 @@ Create a line item
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the created line item","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createReturnLines
|
||||
|
||||
Creates return line items for a given cart based on the return items in a
|
||||
@@ -95,8 +89,6 @@ return.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)[]>","optional":false,"defaultValue":"","description":"the created line items","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createTaxLine
|
||||
|
||||
Create a line item tax line.
|
||||
@@ -109,8 +101,6 @@ Create a line item tax line.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"LineItemTaxLine","type":"`object`","description":"A Line Item Tax Line represents the taxes applied on a line item.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
`**delete**(ids): Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)[]>`
|
||||
@@ -137,8 +127,6 @@ Deletes a line item.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [LineItem](../../entities/classes/entities.LineItem.mdx)>","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteWithTaxLines
|
||||
|
||||
#### Parameters
|
||||
@@ -154,8 +142,6 @@ ___
|
||||
no the cascade on the entity takes care of it
|
||||
Deletes a line item with the tax lines.
|
||||
|
||||
___
|
||||
|
||||
### generate
|
||||
|
||||
Generate a single or multiple line item without persisting the data into the db
|
||||
@@ -170,9 +156,7 @@ Generate a single or multiple line item without persisting the data into the db
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"Generate a single or multiple line item without persisting the data into the db","expandable":false,"children":[]}]} />
|
||||
|
||||
### generateLineItem
|
||||
|
||||
@@ -184,8 +168,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -196,8 +178,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a line item by its id.
|
||||
@@ -210,8 +190,6 @@ Retrieves a line item by its id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)>","optional":false,"defaultValue":"","description":"the line item","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -222,8 +200,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a line item
|
||||
@@ -236,8 +212,6 @@ Updates a line item
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)[]>","optional":false,"defaultValue":"","description":"the updated line item(s)","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateGenerateArguments
|
||||
|
||||
#### Type Parameters
|
||||
@@ -252,8 +226,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -32,8 +32,6 @@ Adds a middleware function to be called after authentication is completed.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"void","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addPreAuthentication
|
||||
|
||||
Adds a middleware function to be called before authentication is completed.
|
||||
@@ -46,8 +44,6 @@ Adds a middleware function to be called before authentication is completed.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"void","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addPreCartCreation
|
||||
|
||||
Adds a middleware function to be called before cart creation
|
||||
@@ -58,9 +54,7 @@ Adds a middleware function to be called before cart creation
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Adds a middleware function to be called before cart creation","expandable":false,"children":[]}]} />
|
||||
|
||||
### addRouter
|
||||
|
||||
@@ -72,8 +66,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getRouters
|
||||
|
||||
#### Parameters
|
||||
@@ -84,8 +76,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Router[]","type":"`Router`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### usePostAuthentication
|
||||
|
||||
Adds post authentication middleware to an express app.
|
||||
@@ -96,9 +86,7 @@ Adds post authentication middleware to an express app.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Adds post authentication middleware to an express app.","expandable":false,"children":[]}]} />
|
||||
|
||||
### usePreAuthentication
|
||||
|
||||
@@ -110,9 +98,7 @@ Adds pre authentication middleware to an express app.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Adds pre authentication middleware to an express app.","expandable":false,"children":[]}]} />
|
||||
|
||||
### usePreCartCreation
|
||||
|
||||
@@ -120,8 +106,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]","type":"RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateMiddleware\_
|
||||
|
||||
Validates a middleware function, throws if fn is not of type function.
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getGiftCardTotals
|
||||
|
||||
Calculate and return the gift cards totals
|
||||
@@ -62,9 +60,7 @@ Calculate and return the gift cards totals
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"Calculate and return the gift cards totals","expandable":false,"children":[]}]} />
|
||||
|
||||
### getGiftCardTransactionsTotals
|
||||
|
||||
@@ -80,8 +76,6 @@ Calculate and return the gift cards totals based on their transactions
|
||||
|
||||
<ParameterTypes parameters={[{"name":"tax_total","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getGiftCardableAmount
|
||||
|
||||
#### Parameters
|
||||
@@ -92,8 +86,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemRefund
|
||||
|
||||
Return the amount that can be refund on a line item
|
||||
@@ -104,9 +96,7 @@ Return the amount that can be refund on a line item
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"Return the amount that can be refund on a line item","expandable":false,"children":[]}]} />
|
||||
|
||||
### getLineItemRefundLegacy
|
||||
|
||||
@@ -118,8 +108,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemTotals
|
||||
|
||||
Calculate and return the items totals for either the legacy calculation or the new calculation
|
||||
@@ -130,9 +118,7 @@ Calculate and return the items totals for either the legacy calculation or the n
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"Calculate and return the items totals for either the legacy calculation or the new calculation","expandable":false,"children":[]}]} />
|
||||
|
||||
### getLineItemTotalsLegacy
|
||||
|
||||
@@ -144,9 +130,7 @@ Calculate and return the legacy calculated totals using the tax rate
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<LineItemTotals>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<LineItemTotals>","optional":false,"defaultValue":"","description":"Calculate and return the legacy calculated totals using the tax rate","expandable":false,"children":[]}]} />
|
||||
|
||||
### getLineItemTotals\_
|
||||
|
||||
@@ -158,9 +142,7 @@ Calculate and return the totals for an item
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<LineItemTotals>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<LineItemTotals>","optional":false,"defaultValue":"","description":"Calculate and return the totals for an item","expandable":false,"children":[]}]} />
|
||||
|
||||
### getShippingMethodTotals
|
||||
|
||||
@@ -172,9 +154,7 @@ Calculate and return the shipping methods totals for either the legacy calculati
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"Calculate and return the shipping methods totals for either the legacy calculation or the new calculation","expandable":false,"children":[]}]} />
|
||||
|
||||
### getShippingMethodTotalsLegacy
|
||||
|
||||
@@ -186,9 +166,7 @@ Calculate and return the shipping method totals legacy using the tax rate
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<ShippingMethodTotals>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<ShippingMethodTotals>","optional":false,"defaultValue":"","description":"Calculate and return the shipping method totals legacy using the tax rate","expandable":false,"children":[]}]} />
|
||||
|
||||
### getShippingMethodTotals\_
|
||||
|
||||
@@ -200,9 +178,7 @@ Calculate and return the shipping method totals
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<ShippingMethodTotals>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<ShippingMethodTotals>","optional":false,"defaultValue":"","description":"Calculate and return the shipping method totals","expandable":false,"children":[]}]} />
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
@@ -214,8 +190,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a note associated with a given author
|
||||
@@ -64,8 +62,6 @@ Creates a note associated with a given author
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Note](../../entities/classes/entities.Note.mdx)>","optional":false,"defaultValue":"","description":"resolves to the creation result","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a given note
|
||||
@@ -76,9 +72,7 @@ Deletes a given note
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Deletes a given note","expandable":false,"children":[]}]} />
|
||||
|
||||
### list
|
||||
|
||||
@@ -92,8 +86,6 @@ Fetches all notes related to the given selector
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Note](../../entities/classes/entities.Note.mdx)[]>","optional":false,"defaultValue":"","description":"notes related to the given search.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Fetches all notes related to the given selector
|
||||
@@ -106,8 +98,6 @@ Fetches all notes related to the given selector
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Note](../../entities/classes/entities.Note.mdx)[], number]>","optional":false,"defaultValue":"","description":"notes related to the given search.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a specific note.
|
||||
@@ -120,8 +110,6 @@ Retrieves a specific note.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Note](../../entities/classes/entities.Note.mdx)>","optional":false,"defaultValue":"","description":"which resolves to the requested note.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -132,8 +120,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a given note with a new value
|
||||
@@ -146,8 +132,6 @@ Updates a given note with a new value
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Note](../../entities/classes/entities.Note.mdx)>","optional":false,"defaultValue":"","description":"resolves to the updated element","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### handleEvent
|
||||
|
||||
Handles an event by relaying the event data to the subscribing providers.
|
||||
@@ -66,8 +64,6 @@ order to allow for resends. Will log any errors that are encountered.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| void \\| [Notification](../../entities/classes/entities.Notification.mdx)[]>","optional":false,"defaultValue":"","description":"the result of notification subscribed","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Retrieves a list of notifications.
|
||||
@@ -80,8 +76,6 @@ Retrieves a list of notifications.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Notification](../../entities/classes/entities.Notification.mdx)[]>","optional":false,"defaultValue":"","description":"the notifications that satisfy the query.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Retrieves a list of notifications and total count.
|
||||
@@ -94,8 +88,6 @@ Retrieves a list of notifications and total count.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Notification](../../entities/classes/entities.Notification.mdx)[], number]>","optional":false,"defaultValue":"","description":"the notifications that satisfy the query as well as the count.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerAttachmentGenerator
|
||||
|
||||
Registers an attachment generator to the service. The generator can be
|
||||
@@ -107,9 +99,7 @@ used to generate on demand invoices or other documents.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Registers an attachment generator to the service. The generator can be\nused to generate on demand invoices or other documents.","expandable":false,"children":[]}]} />
|
||||
|
||||
### registerInstalledProviders
|
||||
|
||||
@@ -121,9 +111,7 @@ Takes a list of notification provider ids and persists them in the database.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Takes a list of notification provider ids and persists them in the database.","expandable":false,"children":[]}]} />
|
||||
|
||||
### resend
|
||||
|
||||
@@ -138,8 +126,6 @@ underlying provider's resendNotification method.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Notification](../../entities/classes/entities.Notification.mdx)>","optional":false,"defaultValue":"","description":"the newly created notification","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a notification with a given id
|
||||
@@ -152,8 +138,6 @@ Retrieves a notification with a given id
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Notification](../../entities/classes/entities.Notification.mdx)>","optional":false,"defaultValue":"","description":"the notification","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveProvider\_
|
||||
|
||||
Finds a provider with a given id. Will throw a NOT\_FOUND error if the
|
||||
@@ -165,9 +149,7 @@ resolution fails.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"AbstractNotificationService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"AbstractNotificationService","type":"`object`","description":"## Overview\n\n:::note[Prerequisites]\n\nBefore creating a Notification Provider, [install an event bus module](https://docs.medusajs.com/development/events/modules/redis).\n\n:::\n\nA Notification Provider is a provider that handles sending and resending of notifications.\n\nTo create a Notification Provider, create a TypeScript or JavaScript file in `src/services`. The name of the file is the name of the provider\n(for example, `sendgrid.ts`). The file must export a class that extends the `AbstractNotificationService` class imported from `@medusajs/medusa`.\n\nFor example, create the file `src/services/email-sender.ts` with the following content:\n\n```ts title=\"src/services/email-sender.ts\"\nimport { AbstractNotificationService } from \"@medusajs/medusa\"\nimport { EntityManager } from \"typeorm\"\n\nclass EmailSenderService extends AbstractNotificationService {\n protected manager_: EntityManager\n protected transactionManager_: EntityManager\n\n sendNotification(\n event: string,\n data: unknown,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record<string, unknown>;\n }> {\n throw new Error(\"Method not implemented.\")\n }\n resendNotification(\n notification: unknown,\n config: unknown,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record<string, unknown>;\n }> {\n throw new Error(\"Method not implemented.\")\n }\n\n}\n\nexport default EmailSenderService\n```\n\n---\n\n## Identifier Property\n\nThe `NotificationProvider` entity has 2 properties: `identifier` and `is_installed`. The value of the `identifier` property in the notification provider\nclass is used when the Notification Provider is created in the database.\n\nThe value of this property is also used later when you want to subscribe the Notification Provider to events in a [Loader](https://docs.medusajs.com/development/loaders/overview).\n\nFor example:\n\n```ts\nclass EmailSenderService extends AbstractNotificationService {\n static identifier = \"email-sender\"\n // ...\n}\n```\n\n---","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
### send
|
||||
|
||||
@@ -182,8 +164,6 @@ method. Persists the Notification in the database.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| [Notification](../../entities/classes/entities.Notification.mdx)>","optional":false,"defaultValue":"","description":"the created notification","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -194,8 +174,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### subscribe
|
||||
|
||||
Subscribes a given provider to an event.
|
||||
@@ -206,9 +184,7 @@ Subscribes a given provider to an event.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Subscribes a given provider to an event.","expandable":false,"children":[]}]} />
|
||||
|
||||
### withTransaction
|
||||
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### generateToken
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -86,8 +80,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refreshToken
|
||||
|
||||
#### Parameters
|
||||
@@ -98,8 +90,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerOauthApp
|
||||
|
||||
#### Parameters
|
||||
@@ -110,8 +100,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
#### Parameters
|
||||
@@ -122,8 +110,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByName
|
||||
|
||||
#### Parameters
|
||||
@@ -134,8 +120,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -146,8 +130,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -158,8 +140,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Oauth](../../entities/classes/entities.Oauth.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-12
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -86,8 +80,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
#### Parameters
|
||||
@@ -98,8 +90,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -110,8 +100,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -28,8 +28,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### inventoryService\_
|
||||
|
||||
#### Returns
|
||||
@@ -50,8 +48,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -70,8 +66,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
#### Parameters
|
||||
@@ -82,8 +76,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### confirm
|
||||
|
||||
#### Parameters
|
||||
@@ -94,8 +86,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -106,8 +96,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### decline
|
||||
|
||||
#### Parameters
|
||||
@@ -118,8 +106,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### decorateTotals
|
||||
|
||||
#### Parameters
|
||||
@@ -130,8 +116,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
@@ -142,8 +126,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteClonedItems
|
||||
|
||||
#### Parameters
|
||||
@@ -154,8 +136,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteItemChange
|
||||
|
||||
#### Parameters
|
||||
@@ -166,8 +146,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -178,8 +156,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -190,8 +166,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refreshAdjustments
|
||||
|
||||
#### Parameters
|
||||
@@ -202,8 +176,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeLineItem
|
||||
|
||||
#### Parameters
|
||||
@@ -214,8 +186,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### requestConfirmation
|
||||
|
||||
#### Parameters
|
||||
@@ -226,8 +196,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
#### Parameters
|
||||
@@ -238,8 +206,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveActive
|
||||
|
||||
#### Parameters
|
||||
@@ -250,8 +216,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| null \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -262,8 +226,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -274,8 +236,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateLineItem
|
||||
|
||||
Create or update order edit item change line item and apply the quantity
|
||||
@@ -288,9 +248,7 @@ Create or update order edit item change line item and apply the quantity
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Create or update order edit item change line item and apply the quantity\n- If the item change already exists then update the quantity of the line item as well as the line adjustments\n- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments","expandable":false,"children":[]}]} />
|
||||
|
||||
### withTransaction
|
||||
|
||||
@@ -302,8 +260,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### isOrderEditActive
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -42,8 +42,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### archive
|
||||
|
||||
Archives an order. It only alloved, if the order has been fulfilled
|
||||
@@ -57,8 +55,6 @@ and payment has been captured.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -77,8 +73,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
Cancels an order.
|
||||
@@ -93,8 +87,6 @@ Throws if payment process has been initiated.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"result of the update operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
Cancels a fulfillment (if related to an order)
|
||||
@@ -107,8 +99,6 @@ Cancels a fulfillment (if related to an order)
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"updated order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### capturePayment
|
||||
|
||||
Captures payment for an order.
|
||||
@@ -121,8 +111,6 @@ Captures payment for an order.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"result of the update operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### completeOrder
|
||||
|
||||
#### Parameters
|
||||
@@ -133,8 +121,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createFromCart
|
||||
|
||||
Creates an order from a cart
|
||||
@@ -147,8 +133,6 @@ Creates an order from a cart
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"resolves to the creation result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
Creates fulfillments for an order.
|
||||
@@ -164,8 +148,6 @@ to their respective fulfillment provider.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"result of the update operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createGiftCardsFromLineItem\_
|
||||
|
||||
#### Parameters
|
||||
@@ -176,8 +158,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise<GiftCard>[]","type":"Promise<[GiftCard](../../entities/classes/entities.GiftCard.mdx)>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createRefund
|
||||
|
||||
Refunds a given amount back to the customer.
|
||||
@@ -190,8 +170,6 @@ Refunds a given amount back to the customer.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the result of the refund operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createShipment
|
||||
|
||||
Adds a shipment to the order to indicate that an order has left the
|
||||
@@ -206,8 +184,6 @@ have been created in regards to the shipment.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the resulting order following the update.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### decorateTotals
|
||||
|
||||
`**decorateTotals**(order, totalsFields?): Promise<[Order](../../entities/classes/entities.Order.mdx)>`
|
||||
@@ -220,7 +196,7 @@ Calculate and attach the different total fields on the object
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"Calculate and attach the different total fields on the object","expandable":false,"children":[]}]} />
|
||||
|
||||
`**decorateTotals**(order, context?): Promise<[Order](../../entities/classes/entities.Order.mdx)>`
|
||||
|
||||
@@ -232,9 +208,7 @@ Calculate and attach the different total fields on the object
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"Calculate and attach the different total fields on the object","expandable":false,"children":[]}]} />
|
||||
|
||||
### decorateTotalsLegacy
|
||||
|
||||
@@ -246,8 +220,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getFulfillmentItems
|
||||
|
||||
Retrieves the order line items, given an array of items.
|
||||
@@ -260,8 +232,6 @@ Retrieves the order line items, given an array of items.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx)[]>","optional":false,"defaultValue":"","description":"the line items generated by the transformer.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getTotalsRelations
|
||||
|
||||
#### Parameters
|
||||
@@ -272,8 +242,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -284,8 +252,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -296,8 +262,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Order](../../entities/classes/entities.Order.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerReturnReceived
|
||||
|
||||
Handles receiving a return. This will create a
|
||||
@@ -316,8 +280,6 @@ mismatches.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets an order by id.
|
||||
@@ -330,8 +292,6 @@ Gets an order by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the order document","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartId
|
||||
|
||||
Gets an order by cart id.
|
||||
@@ -344,8 +304,6 @@ Gets an order by cart id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the order document","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartIdWithTotals
|
||||
|
||||
#### Parameters
|
||||
@@ -356,8 +314,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByExternalId
|
||||
|
||||
Gets an order by id.
|
||||
@@ -370,8 +326,6 @@ Gets an order by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"the order document","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveLegacy
|
||||
|
||||
#### Parameters
|
||||
@@ -382,8 +336,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveWithTotals
|
||||
|
||||
#### Parameters
|
||||
@@ -394,8 +346,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -406,8 +356,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### transformQueryForTotals
|
||||
|
||||
#### Parameters
|
||||
@@ -420,8 +368,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"relations","type":"`undefined` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"select","type":"`undefined` \\| keyof [Order](../../entities/classes/entities.Order.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totalsToSelect","type":"`undefined` \\| keyof [Order](../../entities/classes/entities.Order.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates an order. Metadata updates should
|
||||
@@ -436,8 +382,6 @@ will throw errors if metadata updates are attempted.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Order](../../entities/classes/entities.Order.mdx)>","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateBillingAddress
|
||||
|
||||
Updates the order's billing address.
|
||||
@@ -450,8 +394,6 @@ Updates the order's billing address.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateShippingAddress
|
||||
|
||||
Updates the order's shipping address.
|
||||
@@ -464,8 +406,6 @@ Updates the order's shipping address.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateFulfillmentLineItem
|
||||
|
||||
Checks that a given quantity of a line item can be fulfilled. Fails if the
|
||||
@@ -481,8 +421,6 @@ quantity from the quantity that was originally purchased.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"null \\| LineItem","type":"`null` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)","optional":false,"defaultValue":"","description":"a line item that has the requested fulfillment quantity\n set.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-24
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### authorizePaymentSessions
|
||||
|
||||
Authorizes the payment sessions of a payment collection.
|
||||
@@ -64,8 +62,6 @@ Authorizes the payment sessions of a payment collection.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment collection and its payment session.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a new payment collection.
|
||||
@@ -78,8 +74,6 @@ Creates a new payment collection.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment collection created.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a payment collection.
|
||||
@@ -92,8 +86,6 @@ Deletes a payment collection.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| [PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment collection removed.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### isValidTotalAmount
|
||||
|
||||
#### Parameters
|
||||
@@ -104,8 +96,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### markAsAuthorized
|
||||
|
||||
Marks a payment collection as authorized bypassing the payment flow.
|
||||
@@ -118,8 +108,6 @@ Marks a payment collection as authorized bypassing the payment flow.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment session authorized.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refreshPaymentSession
|
||||
|
||||
Removes and recreate a payment session of a payment collection.
|
||||
@@ -132,8 +120,6 @@ Removes and recreate a payment session of a payment collection.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"the new payment session created.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a payment collection by id.
|
||||
@@ -146,8 +132,6 @@ Retrieves a payment collection by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment collection.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setPaymentSession
|
||||
|
||||
Manages a single payment sessions of a payment collection.
|
||||
@@ -160,8 +144,6 @@ Manages a single payment sessions of a payment collection.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment collection and its payment session.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setPaymentSessionsBatch
|
||||
|
||||
Manages multiple payment sessions of a payment collection.
|
||||
@@ -174,8 +156,6 @@ Manages multiple payment sessions of a payment collection.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment collection and its payment sessions.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -186,8 +166,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a payment collection.
|
||||
@@ -200,8 +178,6 @@ Updates a payment collection.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)>","optional":false,"defaultValue":"","description":"the payment collection updated.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
+6
-60
@@ -30,8 +30,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### paymentService\_
|
||||
|
||||
#### Returns
|
||||
@@ -60,8 +58,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### authorizePayment
|
||||
|
||||
#### Parameters
|
||||
@@ -72,8 +68,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### buildPaymentProcessorContext
|
||||
|
||||
Build the create session context for both legacy and new API
|
||||
@@ -86,8 +80,6 @@ Build the create session context for both legacy and new API
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Cart","type":"`object`","description":"A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"PaymentContext","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancelPayment
|
||||
|
||||
#### Parameters
|
||||
@@ -98,8 +90,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### capturePayment
|
||||
|
||||
#### Parameters
|
||||
@@ -110,8 +100,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createPayment
|
||||
|
||||
#### Parameters
|
||||
@@ -122,8 +110,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createSession
|
||||
|
||||
`**createSession**(providerId, cart): Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>`
|
||||
@@ -148,9 +134,7 @@ Creates a payment session with the given provider.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"Creates a payment session with the given provider.","expandable":false,"children":[]}]} />
|
||||
|
||||
### deleteSession
|
||||
|
||||
@@ -162,8 +146,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getStatus
|
||||
|
||||
#### Parameters
|
||||
@@ -174,16 +156,12 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSessionStatus](../../entities/enums/entities.PaymentSessionStatus.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listPayments
|
||||
|
||||
List all the payments according to the given selector and config.
|
||||
@@ -194,9 +172,7 @@ List all the payments according to the given selector and config.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)[]>","optional":false,"defaultValue":"","description":"List all the payments according to the given selector and config.","expandable":false,"children":[]}]} />
|
||||
|
||||
### processUpdateRequestsData
|
||||
|
||||
@@ -208,9 +184,7 @@ Process the collected data. Can be used every time we need to process some colle
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Process the collected data. Can be used every time we need to process some collected data returned by the provider","expandable":false,"children":[]}]} />
|
||||
|
||||
### refreshSession
|
||||
|
||||
@@ -225,8 +199,6 @@ This means, that we delete the current one and create a new.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"the payment session","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refundFromPayment
|
||||
|
||||
#### Parameters
|
||||
@@ -237,8 +209,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Refund](../../entities/classes/entities.Refund.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refundPayment
|
||||
|
||||
#### Parameters
|
||||
@@ -249,8 +219,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Refund](../../entities/classes/entities.Refund.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerInstalledProviders
|
||||
|
||||
#### Parameters
|
||||
@@ -261,8 +229,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrievePayment
|
||||
|
||||
Retrieve a payment entity with the given id.
|
||||
@@ -273,9 +239,7 @@ Retrieve a payment entity with the given id.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"Retrieve a payment entity with the given id.","expandable":false,"children":[]}]} />
|
||||
|
||||
### retrieveProvider
|
||||
|
||||
@@ -293,8 +257,6 @@ Finds a provider given an id
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TProvider extends AbstractPaymentService ? AbstractPaymentService : TProvider extends AbstractPaymentProcessor ? AbstractPaymentProcessor : any","type":"TProvider extends [AbstractPaymentService](../../medusa/classes/medusa.AbstractPaymentService.mdx) ? [AbstractPaymentService](../../medusa/classes/medusa.AbstractPaymentService.mdx) : TProvider extends [AbstractPaymentProcessor](../../medusa/classes/medusa.AbstractPaymentProcessor.mdx) ? [AbstractPaymentProcessor](../../medusa/classes/medusa.AbstractPaymentProcessor.mdx) : `any`","optional":false,"defaultValue":"","description":"the payment provider","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveRefund
|
||||
|
||||
#### Parameters
|
||||
@@ -305,8 +267,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Refund](../../entities/classes/entities.Refund.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveSession
|
||||
|
||||
Return the payment session for the given id.
|
||||
@@ -317,9 +277,7 @@ Return the payment session for the given id.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"Return the payment session for the given id.","expandable":false,"children":[]}]} />
|
||||
|
||||
### saveSession
|
||||
|
||||
@@ -331,9 +289,7 @@ Create or update a Payment session data.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"Create or update a Payment session data.","expandable":false,"children":[]}]} />
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
@@ -345,8 +301,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### throwFromPaymentProcessorError
|
||||
|
||||
#### Parameters
|
||||
@@ -357,8 +311,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updatePayment
|
||||
|
||||
#### Parameters
|
||||
@@ -369,8 +321,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateSession
|
||||
|
||||
Update a payment session with the given provider.
|
||||
@@ -383,8 +333,6 @@ Update a payment session with the given provider.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"the payment session","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateSessionData
|
||||
|
||||
#### Parameters
|
||||
@@ -395,8 +343,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### capture
|
||||
|
||||
Captures a payment.
|
||||
@@ -64,8 +62,6 @@ Captures a payment.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"the payment captured.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Created a new payment.
|
||||
@@ -78,8 +74,6 @@ Created a new payment.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"the payment created.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refund
|
||||
|
||||
refunds a payment.
|
||||
@@ -92,8 +86,6 @@ refunds a payment.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Refund](../../entities/classes/entities.Refund.mdx)>","optional":false,"defaultValue":"","description":"the refund created.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a payment by id.
|
||||
@@ -106,8 +98,6 @@ Retrieves a payment by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"the payment.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -118,8 +108,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a payment in order to link it to an order or a swap.
|
||||
@@ -132,8 +120,6 @@ Updates a payment in order to link it to an order or a swap.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Payment](../../entities/classes/entities.Payment.mdx)>","optional":false,"defaultValue":"","description":"the payment updated.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ Add `currency_code` to an MA record if `region_id`is passed.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<T[]>","optional":false,"defaultValue":"","description":"updated `prices` list","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addPrices
|
||||
|
||||
Adds prices to a price list in bulk, optionally replacing all existing prices
|
||||
@@ -64,8 +62,6 @@ Adds prices to a price list in bulk, optionally replacing all existing prices
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PriceList](../../entities/classes/entities.PriceList.mdx)>","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -84,8 +80,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### clearPrices
|
||||
|
||||
Removes all prices from a price list and deletes the removed prices in bulk
|
||||
@@ -98,8 +92,6 @@ Removes all prices from a price list and deletes the removed prices in bulk
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a Price List
|
||||
@@ -112,8 +104,6 @@ Creates a Price List
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PriceList](../../entities/classes/entities.PriceList.mdx)>","optional":false,"defaultValue":"","description":"created Price List","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a Price List
|
||||
@@ -127,8 +117,6 @@ Will never fail due to delete being idempotent.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deletePrices
|
||||
|
||||
Removes prices from a price list and deletes the removed prices in bulk
|
||||
@@ -141,8 +129,6 @@ Removes prices from a price list and deletes the removed prices in bulk
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteProductPrices
|
||||
|
||||
#### Parameters
|
||||
@@ -153,8 +139,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[string[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteVariantPrices
|
||||
|
||||
#### Parameters
|
||||
@@ -165,8 +149,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[string[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Lists Price Lists
|
||||
@@ -179,8 +161,6 @@ Lists Price Lists
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PriceList](../../entities/classes/entities.PriceList.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists Price Lists and adds count
|
||||
@@ -193,8 +173,6 @@ Lists Price Lists and adds count
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[PriceList](../../entities/classes/entities.PriceList.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listPriceListsVariantIdsMap
|
||||
|
||||
#### Parameters
|
||||
@@ -205,8 +183,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listProducts
|
||||
|
||||
#### Parameters
|
||||
@@ -217,8 +193,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Product](../../entities/classes/entities.Product.mdx)[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listVariants
|
||||
|
||||
#### Parameters
|
||||
@@ -229,8 +203,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a product tag by id.
|
||||
@@ -243,8 +215,6 @@ Retrieves a product tag by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PriceList](../../entities/classes/entities.PriceList.mdx)>","optional":false,"defaultValue":"","description":"the collection.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -255,8 +225,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a Price List
|
||||
@@ -269,8 +237,6 @@ Updates a Price List
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PriceList](../../entities/classes/entities.PriceList.mdx)>","optional":false,"defaultValue":"","description":"updated Price List","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### upsertCustomerGroups\_
|
||||
|
||||
#### Parameters
|
||||
@@ -281,8 +247,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -30,16 +30,12 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### pricingModuleService
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"IPricingModuleService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### remoteQuery
|
||||
|
||||
#### Returns
|
||||
@@ -68,8 +64,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### calculateTaxes
|
||||
|
||||
Gets the prices for a product variant
|
||||
@@ -82,8 +76,6 @@ Gets the prices for a product variant
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TaxedPricing","type":"`object`","description":"Pricing fields related to taxes.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### collectPricingContext
|
||||
|
||||
Collects additional information necessary for completing the price
|
||||
@@ -91,14 +83,12 @@ selection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<PricingContext>","optional":false,"defaultValue":"","description":"The pricing context","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getPricingModuleVariantMoneyAmounts
|
||||
|
||||
#### Parameters
|
||||
@@ -109,8 +99,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Map<string, [MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProductPricing
|
||||
|
||||
Gets all the variant prices for a product. All the product's variants will
|
||||
@@ -118,28 +106,24 @@ be fetched.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"product","type":"Pick<[Product](../../entities/classes/entities.Product.mdx), \"id\" \\| \"variants\">","description":"the product to get pricing for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"product","type":"Pick<[Product](../../entities/classes/entities.Product.mdx), \"id\" \\| \"variants\">","description":"the product to get pricing for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, [ProductVariantPricing](../../medusa/types/medusa.ProductVariantPricing.mdx)>>","optional":false,"defaultValue":"","description":"A map of variant ids to their corresponding prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProductPricingById
|
||||
|
||||
Gets all the variant prices for a product by the product id
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"productId","type":"`string`","description":"the id of the product to get prices for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"productId","type":"`string`","description":"the id of the product to get prices for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, [ProductVariantPricing](../../medusa/types/medusa.ProductVariantPricing.mdx)>>","optional":false,"defaultValue":"","description":"A map of variant ids to their corresponding prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProductPricing\_
|
||||
|
||||
#### Parameters
|
||||
@@ -150,29 +134,25 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Map<string, Record<string, [ProductVariantPricing](../../medusa/types/medusa.ProductVariantPricing.mdx)>>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantPricing
|
||||
|
||||
Gets the prices for a product variant.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"variant","type":"Pick<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx), \"id\" \\| \"product_id\">","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"variant","type":"Pick<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx), \"id\" \\| \"product_id\">","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariantPricing](../../medusa/types/medusa.ProductVariantPricing.mdx)>","optional":false,"defaultValue":"","description":"The product variant prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantPricingById
|
||||
|
||||
Gets the prices for a product variant by a variant id.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"variantId","type":"`string`","description":"the id of the variant to get prices for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"variantId","type":"`string`","description":"the id of the variant to get prices for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -182,8 +162,6 @@ Gets the prices for a product variant by a variant id.
|
||||
|
||||
Use [getProductVariantsPricing](services.PricingService.mdx#getproductvariantspricing) instead.
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantPricingModulePricing\_
|
||||
|
||||
#### Parameters
|
||||
@@ -194,8 +172,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Map<any, any>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantPricing\_
|
||||
|
||||
#### Parameters
|
||||
@@ -206,36 +182,30 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Map<string, [ProductVariantPricing](../../medusa/types/medusa.ProductVariantPricing.mdx)>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantsPricing
|
||||
|
||||
Gets the prices for a collection of variants.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"data","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"data","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"The product variant prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getShippingOptionPricing
|
||||
|
||||
Gets the prices for a shipping option.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"shippingOption","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"the shipping option to get prices for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"shippingOption","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"the shipping option to get prices for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx) \\| [PricingContext](../../types/interfaces/types.PricingContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PricedShippingOption](../../medusa/types/medusa.PricedShippingOption.mdx)>","optional":false,"defaultValue":"","description":"The shipping option prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setAdminProductPricing
|
||||
|
||||
#### Parameters
|
||||
@@ -246,62 +216,52 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<([Product](../../entities/classes/entities.Product.mdx) \\| [PricedProduct](../../medusa/types/medusa.PricedProduct.mdx))[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setAdminVariantPricing
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PricedVariant](../../medusa/types/medusa.PricedVariant.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setProductPrices
|
||||
|
||||
Set additional prices on a list of products.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"list of products on which to set additional prices","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"list of products on which to set additional prices","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<([Product](../../entities/classes/entities.Product.mdx) \\| [PricedProduct](../../medusa/types/medusa.PricedProduct.mdx))[]>","optional":false,"defaultValue":"","description":"A list of products with variants decorated with prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setShippingOptionPrices
|
||||
|
||||
Set additional prices on a list of shipping options.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"shippingOptions","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]","description":"list of shipping options on which to set additional prices","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Omit<[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx), \"region_id\">","description":"the price selection context to use","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"shippingOptions","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]","description":"list of shipping options on which to set additional prices","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"Omit<[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx), \"region_id\">","description":"the price selection context to use","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PricedShippingOption](../../medusa/types/medusa.PricedShippingOption.mdx)[]>","optional":false,"defaultValue":"","description":"A list of shipping options with prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setVariantPrices
|
||||
|
||||
Set additional prices on a list of product variants.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"the price selection context to use","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[PricedVariant](../../medusa/types/medusa.PricedVariant.mdx)[]>","optional":false,"defaultValue":"","description":"A list of products with variants decorated with prices","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -312,8 +272,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -46,8 +46,6 @@ Add a batch of product to a product category
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the product category on which the products have been added","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -66,8 +64,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a product category
|
||||
@@ -80,8 +76,6 @@ Creates a product category
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)>","optional":false,"defaultValue":"","description":"created product category","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a product category
|
||||
@@ -94,8 +88,6 @@ Deletes a product category
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"a promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### fetchReorderConditions
|
||||
|
||||
#### Parameters
|
||||
@@ -106,8 +98,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ReorderConditions","type":"`ReorderConditions`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists product category based on the provided parameters and includes the count of
|
||||
@@ -121,8 +111,6 @@ product category that match the query.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[], number]>","optional":false,"defaultValue":"","description":"an array containing the product category as\n the first element and the total count of product category that matches the query\n as the second element.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### performReordering
|
||||
|
||||
#### Parameters
|
||||
@@ -133,8 +121,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeProducts
|
||||
|
||||
Remove a batch of product from a product category
|
||||
@@ -147,8 +133,6 @@ Remove a batch of product from a product category
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the product category on which the products have been removed","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a product category by id.
|
||||
@@ -161,8 +145,6 @@ Retrieves a product category by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)>","optional":false,"defaultValue":"","description":"the product category.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByHandle
|
||||
|
||||
Retrieves a product category by handle.
|
||||
@@ -175,8 +157,6 @@ Retrieves a product category by handle.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)>","optional":false,"defaultValue":"","description":"the product category.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve\_
|
||||
|
||||
A generic retrieve for fining product categories by different attributes.
|
||||
@@ -189,8 +169,6 @@ A generic retrieve for fining product categories by different attributes.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)>","optional":false,"defaultValue":"","description":"the product category.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shiftSiblings
|
||||
|
||||
#### Parameters
|
||||
@@ -201,8 +179,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -213,8 +189,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### transformParentIdToEntity
|
||||
|
||||
Accepts an input object and transforms product\_category\_id
|
||||
@@ -228,8 +202,6 @@ into product\_category entity.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<CreateProductCategoryInput \\| UpdateProductCategoryInput>","optional":false,"defaultValue":"","description":"transformed productCategoryInput","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a product category
|
||||
@@ -242,8 +214,6 @@ Updates a product category
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)>","optional":false,"defaultValue":"","description":"updated product category","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-22
@@ -44,8 +44,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -64,8 +62,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a product collection
|
||||
@@ -78,8 +74,6 @@ Creates a product collection
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)>","optional":false,"defaultValue":"","description":"created collection","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a product collection idempotently
|
||||
@@ -92,8 +86,6 @@ Deletes a product collection idempotently
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Lists product collections
|
||||
@@ -106,8 +98,6 @@ Lists product collections
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists product collections and add count.
|
||||
@@ -120,8 +110,6 @@ Lists product collections and add count.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeProducts
|
||||
|
||||
#### Parameters
|
||||
@@ -132,8 +120,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a product collection by id.
|
||||
@@ -146,8 +132,6 @@ Retrieves a product collection by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)>","optional":false,"defaultValue":"","description":"the collection.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByHandle
|
||||
|
||||
Retrieves a product collection by id.
|
||||
@@ -160,8 +144,6 @@ Retrieves a product collection by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)>","optional":false,"defaultValue":"","description":"the collection.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -172,8 +154,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a product collection
|
||||
@@ -186,8 +166,6 @@ Updates a product collection
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)>","optional":false,"defaultValue":"","description":"update collection","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -46,8 +46,6 @@ created option. The same option cannot be added more than once.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"the result of the model update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -66,8 +64,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### count
|
||||
|
||||
Return the total number of documents in database
|
||||
@@ -80,8 +76,6 @@ Return the total number of documents in database
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the result of the count operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a product.
|
||||
@@ -94,8 +88,6 @@ Creates a product.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"resolves to the creation result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### decorateProductsWithSalesChannels
|
||||
|
||||
Temporary method to join sales channels of a product using RemoteQuery while
|
||||
@@ -107,9 +99,7 @@ MedusaV2 FF is on.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)[]>","optional":false,"defaultValue":"","description":"Temporary method to join sales channels of a product using RemoteQuery while\nMedusaV2 FF is on.","expandable":false,"children":[]}]} />
|
||||
|
||||
### delete
|
||||
|
||||
@@ -124,8 +114,6 @@ variants will also be deleted.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteOption
|
||||
|
||||
Delete an option from a product.
|
||||
@@ -138,8 +126,6 @@ Delete an option from a product.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"the updated product","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### filterProductsBySalesChannel
|
||||
|
||||
#### Parameters
|
||||
@@ -150,8 +136,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getSalesChannelModuleChannels
|
||||
|
||||
Temporary method to fetch sales channels of a product using RemoteQuery while
|
||||
@@ -163,9 +147,7 @@ MedusaV2 FF is on.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, [SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, [SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]>>","optional":false,"defaultValue":"","description":"Temporary method to fetch sales channels of a product using RemoteQuery while\nMedusaV2 FF is on.","expandable":false,"children":[]}]} />
|
||||
|
||||
### isProductInSalesChannels
|
||||
|
||||
@@ -177,9 +159,7 @@ Check if the product is assigned to at least one of the provided sales channels.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"Check if the product is assigned to at least one of the provided sales channels.","expandable":false,"children":[]}]} />
|
||||
|
||||
### list
|
||||
|
||||
@@ -193,8 +173,6 @@ Lists products based on the provided parameters.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists products based on the provided parameters and includes the count of
|
||||
@@ -208,8 +186,6 @@ products that match the query.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Product](../../entities/classes/entities.Product.mdx)[], number]>","optional":false,"defaultValue":"","description":"an array containing the products as\n the first element and the total count of products that matches the query\n as the second element.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listTagsByUsage
|
||||
|
||||
#### Parameters
|
||||
@@ -220,16 +196,12 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listTypes
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductType](../../entities/classes/entities.ProductType.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### prepareListQuery\_
|
||||
|
||||
Temporary method to be used in place we need custom query strategy to prevent typeorm bug
|
||||
@@ -244,8 +216,6 @@ Temporary method to be used in place we need custom query strategy to prevent ty
|
||||
|
||||
<ParameterTypes parameters={[{"name":"q","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`FindWithoutRelationsOptions`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"keyof [Product](../../entities/classes/entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### reorderVariants
|
||||
|
||||
#### Parameters
|
||||
@@ -256,8 +226,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a product by id.
|
||||
@@ -271,8 +239,6 @@ Throws in case of DB Error and if product was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"the result of the find one operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByExternalId
|
||||
|
||||
Gets a product by external id.
|
||||
@@ -286,8 +252,6 @@ Throws in case of DB Error and if product was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"the result of the find one operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByHandle
|
||||
|
||||
Gets a product by handle.
|
||||
@@ -301,8 +265,6 @@ Throws in case of DB Error and if product was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"the result of the find one operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveOptionByTitle
|
||||
|
||||
Retrieve product's option by title.
|
||||
@@ -315,8 +277,6 @@ Retrieve product's option by title.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<null \\| [ProductOption](../../entities/classes/entities.ProductOption.mdx)>","optional":false,"defaultValue":"","description":"product option","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveVariants
|
||||
|
||||
Gets all variants belonging to a product.
|
||||
@@ -329,8 +289,6 @@ Gets all variants belonging to a product.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]>","optional":false,"defaultValue":"","description":"an array of variants","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve\_
|
||||
|
||||
Gets a product by selector.
|
||||
@@ -344,8 +302,6 @@ Throws in case of DB Error and if product was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"the result of the find one operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -356,8 +312,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a product. Product variant updates should use dedicated methods,
|
||||
@@ -372,8 +326,6 @@ product variant updates are attempted.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateOption
|
||||
|
||||
Updates a product's option. Throws if the call tries to update an option
|
||||
@@ -387,8 +339,6 @@ not associated with the product. Throws if the updated title already exists.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)>","optional":false,"defaultValue":"","description":"the updated product","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateShippingProfile
|
||||
|
||||
Assign a product to a profile, if a profile id null is provided then detach the product from the profile
|
||||
@@ -401,8 +351,6 @@ Assign a product to a profile, if a profile id null is provided then detach the
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Product](../../entities/classes/entities.Product.mdx)[]>","optional":false,"defaultValue":"","description":"updated products","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Lists product types
|
||||
@@ -64,8 +62,6 @@ Lists product types
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductType](../../entities/classes/entities.ProductType.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists product types and adds count.
|
||||
@@ -78,8 +74,6 @@ Lists product types and adds count.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[ProductType](../../entities/classes/entities.ProductType.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a product type by id.
|
||||
@@ -93,8 +87,6 @@ Throws in case of DB Error and if product was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductType](../../entities/classes/entities.ProductType.mdx)>","optional":false,"defaultValue":"","description":"the result of the find one operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -105,8 +97,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
+5
-47
@@ -28,16 +28,12 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### inventoryService\_
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"IInventoryService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### stockLocationService\_
|
||||
|
||||
#### Returns
|
||||
@@ -58,9 +54,7 @@ Adjusts inventory of a variant on a location
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Adjusts inventory of a variant on a location","expandable":false,"children":[]}]} />
|
||||
|
||||
### adjustReservationsQuantityByLineItem
|
||||
|
||||
@@ -72,9 +66,7 @@ Adjusts the quantity of reservations for a line item by a given amount.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Adjusts the quantity of reservations for a line item by a given amount.","expandable":false,"children":[]}]} />
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
@@ -94,8 +86,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### attachInventoryItem
|
||||
|
||||
`**attachInventoryItem**(attachments): Promise<[ProductVariantInventoryItem](../../entities/classes/entities.ProductVariantInventoryItem.mdx)[]>`
|
||||
@@ -120,8 +110,6 @@ Attach a variant to an inventory item
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariantInventoryItem](../../entities/classes/entities.ProductVariantInventoryItem.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### confirmInventory
|
||||
|
||||
confirms if requested inventory is available
|
||||
@@ -134,8 +122,6 @@ confirms if requested inventory is available
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Boolean>","optional":false,"defaultValue":"","description":"boolean indicating if inventory is available","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteReservationsByLineItem
|
||||
|
||||
delete a reservation of variant quantity
|
||||
@@ -146,9 +132,7 @@ delete a reservation of variant quantity
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"delete a reservation of variant quantity","expandable":false,"children":[]}]} />
|
||||
|
||||
### detachInventoryItem
|
||||
|
||||
@@ -160,9 +144,7 @@ Remove a variant from an inventory item
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Remove a variant from an inventory item","expandable":false,"children":[]}]} />
|
||||
|
||||
### getAvailabilityContext
|
||||
|
||||
@@ -174,8 +156,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Required<AvailabilityContext>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getVariantQuantityFromVariantInventoryItems
|
||||
|
||||
Get the quantity of a variant from a list of variantInventoryItems
|
||||
@@ -191,8 +171,6 @@ the given variant.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"The available quantity of the variant from the inventoryItems","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listByItem
|
||||
|
||||
list registered inventory items
|
||||
@@ -205,8 +183,6 @@ list registered inventory items
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariantInventoryItem](../../entities/classes/entities.ProductVariantInventoryItem.mdx)[]>","optional":false,"defaultValue":"","description":"list of inventory items","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listByVariant
|
||||
|
||||
List inventory items for a specific variant
|
||||
@@ -219,8 +195,6 @@ List inventory items for a specific variant
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariantInventoryItem](../../entities/classes/entities.ProductVariantInventoryItem.mdx)[]>","optional":false,"defaultValue":"","description":"variant inventory items for the variant id","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listInventoryItemsByVariant
|
||||
|
||||
lists inventory items for a given variant
|
||||
@@ -233,8 +207,6 @@ lists inventory items for a given variant
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[InventoryItemDTO](../../medusa/types/medusa.InventoryItemDTO.mdx)[]>","optional":false,"defaultValue":"","description":"lidt of inventory items for the variant","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listVariantsByItem
|
||||
|
||||
lists variant by inventory item id
|
||||
@@ -247,8 +219,6 @@ lists variant by inventory item id
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]>","optional":false,"defaultValue":"","description":"a list of product variants that are associated with the item id","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### reserveQuantity
|
||||
|
||||
Reserves a quantity of a variant
|
||||
@@ -259,9 +229,7 @@ Reserves a quantity of a variant
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)[]>","optional":false,"defaultValue":"","description":"Reserves a quantity of a variant","expandable":false,"children":[]}]} />
|
||||
|
||||
### retrieve
|
||||
|
||||
@@ -275,8 +243,6 @@ Retrieves a product variant inventory item by its inventory item ID and variant
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariantInventoryItem](../../entities/classes/entities.ProductVariantInventoryItem.mdx)>","optional":false,"defaultValue":"","description":"A promise that resolves with the product variant inventory item.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setProductAvailability
|
||||
|
||||
#### Parameters
|
||||
@@ -287,8 +253,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<([Product](../../entities/classes/entities.Product.mdx) \\| [PricedProduct](../../medusa/types/medusa.PricedProduct.mdx))[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setVariantAvailability
|
||||
|
||||
#### Parameters
|
||||
@@ -299,8 +263,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[] \\| [PricedVariant](../../medusa/types/medusa.PricedVariant.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -311,8 +273,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateInventoryAtLocation
|
||||
|
||||
Validate stock at a location for fulfillment items
|
||||
@@ -325,8 +285,6 @@ Validate stock at a location for fulfillment items
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"nothing if successful, throws error if not","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
+5
-51
@@ -48,8 +48,6 @@ Option value must be of type string or number.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductOptionValue](../../entities/classes/entities.ProductOptionValue.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -68,8 +66,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates an unpublished product variant. Will validate against parent product
|
||||
@@ -87,8 +83,6 @@ to ensure that the variant can in fact be created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TOutput>","optional":false,"defaultValue":"","description":"resolves to the creation result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes variant or variants.
|
||||
@@ -102,8 +96,6 @@ Will never fail due to delete being idempotent.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteOptionValue
|
||||
|
||||
Deletes option value from given variant.
|
||||
@@ -117,8 +109,6 @@ Will never fail due to delete being idempotent.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getFreeTextQueryBuilder\_
|
||||
|
||||
Lists variants based on the provided parameters and includes the count of
|
||||
@@ -132,8 +122,6 @@ variants that match the query.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"SelectQueryBuilder","type":"SelectQueryBuilder<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)>","optional":false,"defaultValue":"","description":"an array containing the products as the first element and the total\n count of products that matches the query as the second element.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getRegionPrice
|
||||
|
||||
Gets the price specific to a region. If no region specific money amount
|
||||
@@ -148,8 +136,6 @@ currency price exists the function will throw an error.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<null \\| number>","optional":false,"defaultValue":"","description":"the price specific to the region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### isVariantInSalesChannels
|
||||
|
||||
Check if the variant is assigned to at least one of the provided sales channels.
|
||||
@@ -160,62 +146,52 @@ Check if the variant is assigned to at least one of the provided sales channels.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"Check if the variant is assigned to at least one of the provided sales channels.","expandable":false,"children":[]}]} />
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"selector","type":"[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps.mdx)","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"selector","type":"[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps.mdx)","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"selector","type":"[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps.mdx)","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"selector","type":"[FilterableProductVariantProps](../../product/interfaces/product.FilterableProductVariantProps.mdx)","description":"the query object for find","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a product variant by id.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"variantId","type":"`string`","description":"the id of the product to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"variantId","type":"`string`","description":"the id of the product to get.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)>","optional":false,"defaultValue":"","description":"the product document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveBySKU
|
||||
|
||||
Gets a product variant by id.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"sku","type":"`string`","description":"The unique stock keeping unit used to identify the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/types/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"sku","type":"`string`","description":"The unique stock keeping unit used to identify the product variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)> & [PriceSelectionContext](../../medusa/interfaces/medusa.PriceSelectionContext.mdx)","description":"query config object for variant retrieval.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)>","optional":false,"defaultValue":"","description":"the product document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setCurrencyPrice
|
||||
|
||||
#### Parameters
|
||||
@@ -231,8 +207,6 @@ ___
|
||||
use addOrUpdateCurrencyPrices instead
|
||||
Sets the default price for the given currency.
|
||||
|
||||
___
|
||||
|
||||
### setRegionPrice
|
||||
|
||||
#### Parameters
|
||||
@@ -248,8 +222,6 @@ ___
|
||||
use addOrUpdateRegionPrices instead
|
||||
Sets the default price of a specific region
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -260,8 +232,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
`**update**(variantData): Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]>`
|
||||
@@ -300,8 +270,6 @@ The function will throw, if price updates are attempted.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateBatch
|
||||
|
||||
#### Parameters
|
||||
@@ -312,8 +280,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateOptionValue
|
||||
|
||||
Updates variant's option value.
|
||||
@@ -327,8 +293,6 @@ Option value must be of type string or number.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductOptionValue](../../entities/classes/entities.ProductOptionValue.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateVariantPrices
|
||||
|
||||
`**updateVariantPrices**(data): Promise<void>`
|
||||
@@ -357,8 +321,6 @@ Deletes any prices that are not in the update object, and is not associated with
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"empty promise","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateVariantPricesBatch
|
||||
|
||||
#### Parameters
|
||||
@@ -369,8 +331,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### upsertCurrencyPrices
|
||||
|
||||
#### Parameters
|
||||
@@ -381,8 +341,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### upsertRegionPrices
|
||||
|
||||
#### Parameters
|
||||
@@ -393,8 +351,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateVariantsToCreate\_
|
||||
|
||||
#### Parameters
|
||||
@@ -405,8 +361,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -46,8 +46,6 @@ Adds a country to the region.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addFulfillmentProvider
|
||||
|
||||
Adds a fulfillment provider that is available in the region. Fails if the
|
||||
@@ -61,8 +59,6 @@ provider doesn't exist.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addPaymentProvider
|
||||
|
||||
Adds a payment provider that is available in the region. Fails if the
|
||||
@@ -76,8 +72,6 @@ provider doesn't exist.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -96,8 +90,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a region.
|
||||
@@ -110,8 +102,6 @@ Creates a region.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the newly created region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a region.
|
||||
@@ -124,8 +114,6 @@ Deletes a region.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
Lists all regions based on a query
|
||||
@@ -138,8 +126,6 @@ Lists all regions based on a query
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)[]>","optional":false,"defaultValue":"","description":"result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists all regions based on a query and returns them along with count
|
||||
@@ -152,8 +138,6 @@ Lists all regions based on a query and returns them along with count
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Region](../../entities/classes/entities.Region.mdx)[], number]>","optional":false,"defaultValue":"","description":"result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeCountry
|
||||
|
||||
Removes a country from a Region.
|
||||
@@ -166,8 +150,6 @@ Removes a country from a Region.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeFulfillmentProvider
|
||||
|
||||
Removes a fulfillment provider from a region. Is idempotent.
|
||||
@@ -180,8 +162,6 @@ Removes a fulfillment provider from a region. Is idempotent.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removePaymentProvider
|
||||
|
||||
Removes a payment provider from a region. Is idempotent.
|
||||
@@ -194,8 +174,6 @@ Removes a payment provider from a region. Is idempotent.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a region by its id.
|
||||
@@ -208,8 +186,6 @@ Retrieves a region by its id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the region","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCountryCode
|
||||
|
||||
Retrieve a region by country code.
|
||||
@@ -222,8 +198,6 @@ Retrieve a region by country code.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"a Region with country code","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByName
|
||||
|
||||
Retrieves a region by name.
|
||||
@@ -236,8 +210,6 @@ Retrieves a region by name.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"region with the matching name","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -248,8 +220,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a region
|
||||
@@ -262,8 +232,6 @@ Updates a region
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Region](../../entities/classes/entities.Region.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateCountry
|
||||
|
||||
Validates a country code. Will normalize the code before checking for
|
||||
@@ -277,8 +245,6 @@ existence.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Country](../../entities/classes/entities.Country.mdx)>","optional":false,"defaultValue":"","description":"the validated Country","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateCurrency
|
||||
|
||||
Validates a currency code. Will throw if the currency code doesn't exist.
|
||||
@@ -295,8 +261,6 @@ Validates a currency code. Will throw if the currency code doesn't exist.
|
||||
|
||||
if the provided currency code is invalid
|
||||
|
||||
___
|
||||
|
||||
### validateFields
|
||||
|
||||
Validates fields for creation and updates. If the region already exists
|
||||
@@ -314,8 +278,6 @@ the id can be passed to check that country updates are allowed.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<DeepPartial<[Region](../../entities/classes/entities.Region.mdx)>>","optional":false,"defaultValue":"","description":"the validated region data","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateTaxRate
|
||||
|
||||
Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
|
||||
@@ -332,8 +294,6 @@ Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
|
||||
|
||||
if the tax rate isn't number between 0-100
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -86,8 +80,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets an order by id.
|
||||
@@ -100,8 +92,6 @@ Gets an order by id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)>","optional":false,"defaultValue":"","description":"the order document","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -112,8 +102,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -124,8 +112,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
Cancels a return if possible. Returns can be canceled if it has not been received.
|
||||
@@ -64,8 +62,6 @@ Cancels a return if possible. Returns can be canceled if it has not been receive
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)>","optional":false,"defaultValue":"","description":"the updated Return","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a return request for an order, with given items, and a shipping
|
||||
@@ -80,8 +76,6 @@ the return lines and the shipping cost.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)>","optional":false,"defaultValue":"","description":"the created return","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### fulfill
|
||||
|
||||
#### Parameters
|
||||
@@ -92,8 +86,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getFulfillmentItems
|
||||
|
||||
Retrieves the order line items, given an array of items
|
||||
@@ -106,8 +98,6 @@ Retrieves the order line items, given an array of items
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineItem](../../entities/classes/entities.LineItem.mdx) & object[]>","optional":false,"defaultValue":"","description":"the line items generated by the transformer.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -118,8 +108,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -130,8 +118,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Return](../../entities/classes/entities.Return.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### receive
|
||||
|
||||
Registers a previously requested return as received. This will create a
|
||||
@@ -150,8 +136,6 @@ mismatches.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a return by its id.
|
||||
@@ -164,8 +148,6 @@ Retrieves a return by its id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)>","optional":false,"defaultValue":"","description":"the return","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveBySwap
|
||||
|
||||
#### Parameters
|
||||
@@ -176,8 +158,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -188,8 +168,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -200,8 +178,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Return](../../entities/classes/entities.Return.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateReturnLineItem
|
||||
|
||||
Checks that a given quantity of a line item can be returned. Fails if the
|
||||
@@ -216,8 +192,6 @@ the quantity that is requested to be returned.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"DeepPartial","type":"DeepPartial<[LineItem](../../entities/classes/entities.LineItem.mdx)>","optional":false,"defaultValue":"","description":"a line item where the quantity is set to the requested\n return quantity.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateReturnStatuses
|
||||
|
||||
Checks that an order has the statuses necessary to complete a return.
|
||||
@@ -230,14 +204,12 @@ payment\_status must be captured.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Checks that an order has the statuses necessary to complete a return.\nfulfillment\\_status cannot be not\\_fulfilled or returned.\npayment\\_status must be captured.","expandable":false,"children":[]}]} />
|
||||
|
||||
#### Throws
|
||||
|
||||
when statuses are not sufficient for returns.
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-8
@@ -28,8 +28,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### inventoryService\_
|
||||
|
||||
#### Returns
|
||||
@@ -58,8 +56,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveAvailableItemQuantity
|
||||
|
||||
Retrieves the available quantity of an item across all sales channel locations
|
||||
@@ -72,8 +68,6 @@ Retrieves the available quantity of an item across all sales channel locations
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"available quantity of item across all sales channel locations","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -84,8 +78,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-14
@@ -30,8 +30,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### stockLocationService\_
|
||||
|
||||
#### Returns
|
||||
@@ -54,8 +52,6 @@ Associates a sales channel with a stock location.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"A promise that resolves when the association has been created.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -74,8 +70,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listLocationIds
|
||||
|
||||
Lists the stock locations associated with a sales channel.
|
||||
@@ -88,8 +82,6 @@ Lists the stock locations associated with a sales channel.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string[]>","optional":false,"defaultValue":"","description":"A promise that resolves with an array of location IDs.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listSalesChannelIds
|
||||
|
||||
Lists the sales channels associated with a stock location.
|
||||
@@ -102,8 +94,6 @@ Lists the sales channels associated with a stock location.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string[]>","optional":false,"defaultValue":"","description":"A promise that resolves with an array of sales channel IDs.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeLocation
|
||||
|
||||
Removes an association between a sales channel and a stock location.
|
||||
@@ -116,8 +106,6 @@ Removes an association between a sales channel and a stock location.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"A promise that resolves when the association has been removed.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -128,8 +116,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -44,8 +44,6 @@ Add a batch of product to a sales channel
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"the sales channel on which the products have been added","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -64,8 +62,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a SalesChannel
|
||||
@@ -81,8 +77,6 @@ To use this feature please enable the corresponding feature flag in your medusa
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"the created channel","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createDefault
|
||||
|
||||
Creates a default sales channel, if this does not already exist.
|
||||
@@ -91,8 +85,6 @@ Creates a default sales channel, if this does not already exist.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"the sales channel","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a sales channel from
|
||||
@@ -105,9 +97,7 @@ To use this feature please enable the corresponding feature flag in your medusa
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"Deletes a sales channel from\n This feature is under development and may change in the future.\nTo use this feature please enable the corresponding feature flag in your medusa backend project.","expandable":false,"children":[]}]} />
|
||||
|
||||
### list
|
||||
|
||||
@@ -121,8 +111,6 @@ Lists sales channels based on the provided parameters.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]>","optional":false,"defaultValue":"","description":"an array containing the sales channels","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
Lists sales channels based on the provided parameters and include the count of
|
||||
@@ -136,8 +124,6 @@ sales channels that match the query.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[], number]>","optional":false,"defaultValue":"","description":"an array containing the sales channels as\n the first element and the total count of sales channels that matches the query\n as the second element.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listProductIdsBySalesChannelIds
|
||||
|
||||
List all product ids that belongs to the sales channels ids
|
||||
@@ -148,9 +134,7 @@ List all product ids that belongs to the sales channels ids
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"List all product ids that belongs to the sales channels ids","expandable":false,"children":[]}]} />
|
||||
|
||||
### removeProducts
|
||||
|
||||
@@ -164,8 +148,6 @@ Remove a batch of product from a sales channel
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"the sales channel on which the products have been removed","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieve a SalesChannel by id
|
||||
@@ -178,8 +160,6 @@ Retrieve a SalesChannel by id
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"a sales channel","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByName
|
||||
|
||||
Find a sales channel by name.
|
||||
@@ -192,8 +172,6 @@ Find a sales channel by name.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<unknown>","optional":false,"defaultValue":"","description":"a sales channel with matching name","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveDefault
|
||||
|
||||
Retrieves the default sales channel.
|
||||
@@ -202,8 +180,6 @@ Retrieves the default sales channel.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"the sales channel","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve\_
|
||||
|
||||
A generic retrieve used to find a sales channel by different attributes.
|
||||
@@ -216,8 +192,6 @@ A generic retrieve used to find a sales channel by different attributes.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"a single SC matching the query or throws","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -228,8 +202,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -240,8 +212,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -42,8 +42,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createIndex
|
||||
|
||||
#### Parameters
|
||||
@@ -54,8 +52,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteAllDocuments
|
||||
|
||||
#### Parameters
|
||||
@@ -66,8 +62,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteDocument
|
||||
|
||||
#### Parameters
|
||||
@@ -78,8 +72,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getIndex
|
||||
|
||||
#### Parameters
|
||||
@@ -90,8 +82,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### replaceDocuments
|
||||
|
||||
#### Parameters
|
||||
@@ -102,8 +92,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### search
|
||||
|
||||
#### Parameters
|
||||
@@ -114,8 +102,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateSettings
|
||||
|
||||
#### Parameters
|
||||
@@ -126,8 +112,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### isSearchService
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -47,8 +47,6 @@ is allowed.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)>","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -67,8 +65,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a new shipping option. Used both for outbound and inbound shipping
|
||||
@@ -83,8 +79,6 @@ defaults to false.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)>","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createShippingMethod
|
||||
|
||||
Creates a shipping method for a given cart.
|
||||
@@ -97,8 +91,6 @@ Creates a shipping method for a given cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)>","optional":false,"defaultValue":"","description":"the resulting shipping method.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a profile with a given profile id.
|
||||
@@ -111,8 +103,6 @@ Deletes a profile with a given profile id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [ShippingOption](../../entities/classes/entities.ShippingOption.mdx)>","optional":false,"defaultValue":"","description":"the result of the delete operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteShippingMethods
|
||||
|
||||
Removes a given shipping method
|
||||
@@ -125,8 +115,6 @@ Removes a given shipping method
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]>","optional":false,"defaultValue":"","description":"removed shipping methods","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getPrice\_
|
||||
|
||||
Returns the amount to be paid for a shipping method. Will ask the
|
||||
@@ -141,8 +129,6 @@ price type "calculated".
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the price of the shipping option.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -153,8 +139,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -165,8 +149,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeRequirement
|
||||
|
||||
Removes a requirement from a shipping option
|
||||
@@ -179,8 +161,6 @@ Removes a requirement from a shipping option
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)>","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a profile by id.
|
||||
@@ -194,8 +174,6 @@ Throws in case of DB Error and if profile was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)>","optional":false,"defaultValue":"","description":"the profile document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -206,8 +184,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a profile. Metadata updates and product updates should use
|
||||
@@ -222,8 +198,6 @@ will throw errors if metadata or product updates are attempted.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)>","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateShippingMethod
|
||||
|
||||
Updates a shipping method's associations. Useful when a cart is completed
|
||||
@@ -237,8 +211,6 @@ and its methods should be copied to an order/swap entity.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<undefined \\| [ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)>","optional":false,"defaultValue":"","description":"the resulting shipping method","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updateShippingProfile
|
||||
|
||||
#### Parameters
|
||||
@@ -249,8 +221,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]>","optional":false,"defaultValue":"","description":"updated shipping options","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateAndMutatePrice
|
||||
|
||||
#### Parameters
|
||||
@@ -261,8 +231,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<CreateShippingOptionInput \\| Omit<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx), \"beforeInsert\">>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateCartOption
|
||||
|
||||
Checks if a given option id is a valid option for a cart. If it is the
|
||||
@@ -277,8 +245,6 @@ match, or when the shipping option requirements are not satisfied.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<null \\| [ShippingOption](../../entities/classes/entities.ShippingOption.mdx)>","optional":false,"defaultValue":"","description":"the validated shipping option","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validatePriceType\_
|
||||
|
||||
Validates a shipping option price
|
||||
@@ -291,8 +257,6 @@ Validates a shipping option price
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOptionPriceType](../../entities/enums/entities.ShippingOptionPriceType.mdx)>","optional":false,"defaultValue":"","description":"the validated price","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### validateRequirement\_
|
||||
|
||||
Validates a requirement
|
||||
@@ -305,8 +269,6 @@ Validates a requirement
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOptionRequirement](../../entities/classes/entities.ShippingOptionRequirement.mdx)>","optional":false,"defaultValue":"","description":"a validated shipping requirement","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ ___
|
||||
|
||||
use [addProducts](services.ShippingProfileService.mdx#addproducts) instead
|
||||
|
||||
___
|
||||
|
||||
### addProducts
|
||||
|
||||
Adds a product or an array of products to the profile.
|
||||
@@ -64,8 +62,6 @@ Adds a product or an array of products to the profile.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addShippingOption
|
||||
|
||||
Adds a shipping option to the profile. The shipping option can be used to
|
||||
@@ -79,8 +75,6 @@ fulfill the products in the products field.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the result of the model update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -99,8 +93,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a new shipping profile.
|
||||
@@ -113,8 +105,6 @@ Creates a new shipping profile.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the result of the create operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createDefault
|
||||
|
||||
Creates a default shipping profile, if this does not already exist.
|
||||
@@ -123,8 +113,6 @@ Creates a default shipping profile, if this does not already exist.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the shipping profile","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createGiftCardDefault
|
||||
|
||||
Creates a default shipping profile, for gift cards if unless it already
|
||||
@@ -134,8 +122,6 @@ exists.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the shipping profile","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a profile with a given profile id.
|
||||
@@ -148,8 +134,6 @@ Deletes a profile with a given profile id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the delete operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### fetchCartOptions
|
||||
|
||||
Finds all the shipping profiles that cover the products in a cart, and
|
||||
@@ -163,8 +147,6 @@ validates all options that are available for the cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]>","optional":false,"defaultValue":"","description":"a list of the available shipping options","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getMapProfileIdsByProductIds
|
||||
|
||||
#### Parameters
|
||||
@@ -175,8 +157,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Map<string, string>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getProfilesInCart
|
||||
|
||||
Returns a list of all the productIds in the cart.
|
||||
@@ -189,8 +169,6 @@ Returns a list of all the productIds in the cart.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string[]>","optional":false,"defaultValue":"","description":"a list of product ids","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -201,8 +179,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeProducts
|
||||
|
||||
Removes a product or an array of products from the profile.
|
||||
@@ -215,8 +191,6 @@ Removes a product or an array of products from the profile.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the result of update","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a profile by id.
|
||||
@@ -230,16 +204,12 @@ Throws in case of DB Error and if profile was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the profile document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveDefault
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveForProducts
|
||||
|
||||
#### Parameters
|
||||
@@ -250,8 +220,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveGiftCardDefault
|
||||
|
||||
Retrieves the default gift card profile
|
||||
@@ -260,8 +228,6 @@ Retrieves the default gift card profile
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"the shipping profile for gift cards","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -272,8 +238,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a profile. Metadata updates and product updates should use
|
||||
@@ -288,8 +252,6 @@ will throw errors if metadata or product updates are attempted.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)>","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -64,8 +62,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[StagedJob](../../entities/classes/entities.StagedJob.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
@@ -76,8 +72,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -88,8 +82,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[StagedJob](../../entities/classes/entities.StagedJob.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -100,8 +92,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -46,8 +46,6 @@ Add a currency to the store
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Store](../../entities/classes/entities.Store.mdx)>","optional":false,"defaultValue":"","description":"result after update","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -66,8 +64,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a store if it doesn't already exist.
|
||||
@@ -76,8 +72,6 @@ Creates a store if it doesn't already exist.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Store](../../entities/classes/entities.Store.mdx)>","optional":false,"defaultValue":"","description":"The store.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getDefaultCurrency\_
|
||||
|
||||
#### Parameters
|
||||
@@ -88,8 +82,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Partial","type":"Partial<[Currency](../../entities/classes/entities.Currency.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeCurrency
|
||||
|
||||
Removes a currency from the store
|
||||
@@ -102,8 +94,6 @@ Removes a currency from the store
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<any>","optional":false,"defaultValue":"","description":"result after update","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieve the store settings. There is always a maximum of one store.
|
||||
@@ -116,8 +106,6 @@ Retrieve the store settings. There is always a maximum of one store.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Store](../../entities/classes/entities.Store.mdx)>","optional":false,"defaultValue":"","description":"the store","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -128,8 +116,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a store
|
||||
@@ -142,8 +128,6 @@ Updates a store
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Store](../../entities/classes/entities.Store.mdx)>","optional":false,"defaultValue":"","description":"resolves to the update result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### resolveBatchJobByType
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"AbstractBatchJobStrategy","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -44,8 +44,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<boolean>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -64,8 +62,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
Cancels a given swap if possible. A swap can only be canceled if all
|
||||
@@ -80,8 +76,6 @@ is associated with a refund, it cannot be canceled.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the canceled swap.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
Cancels a fulfillment (if related to a swap)
|
||||
@@ -94,8 +88,6 @@ Cancels a fulfillment (if related to a swap)
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"updated swap","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a swap from an order, with given return items, additional items
|
||||
@@ -109,8 +101,6 @@ and an optional return shipping method.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the newly created swap","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createCart
|
||||
|
||||
Creates a cart from the given swap. The cart can be used to pay
|
||||
@@ -126,8 +116,6 @@ swap.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the swap with its cart\\_id prop set to the id of the new cart.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
Fulfills the additional items associated with the swap. Will call the
|
||||
@@ -141,8 +129,6 @@ fulfillment providers associated with the shipping methods.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the updated swap with new status and fulfillments.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createShipment
|
||||
|
||||
Marks a fulfillment as shipped and attaches tracking numbers.
|
||||
@@ -155,8 +141,6 @@ Marks a fulfillment as shipped and attaches tracking numbers.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the updated swap with new fulfillments and status.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deleteMetadata
|
||||
|
||||
Dedicated method to delete metadata for a swap.
|
||||
@@ -169,8 +153,6 @@ Dedicated method to delete metadata for a swap.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"resolves to the updated result.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
List swaps.
|
||||
@@ -183,8 +165,6 @@ List swaps.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
List swaps.
|
||||
@@ -197,8 +177,6 @@ List swaps.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[Swap](../../entities/classes/entities.Swap.mdx)[], number]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### processDifference
|
||||
|
||||
Process difference for the requested swap.
|
||||
@@ -211,8 +189,6 @@ Process difference for the requested swap.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"processed swap","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerCartCompletion
|
||||
|
||||
Register a cart completion
|
||||
@@ -225,8 +201,6 @@ Register a cart completion
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"swap related to the cart","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerReceived
|
||||
|
||||
Registers the swap return items as received so that they cannot be used
|
||||
@@ -240,8 +214,6 @@ as a part of other swaps/returns.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the resulting order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Retrieves a swap with the given id.
|
||||
@@ -254,8 +226,6 @@ Retrieves a swap with the given id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the swap","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartId
|
||||
|
||||
Retrieves a swap based on its associated cart id
|
||||
@@ -268,8 +238,6 @@ Retrieves a swap based on its associated cart id
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"the swap","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -280,8 +248,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### transformQueryForCart
|
||||
|
||||
Transform find config object for retrieval.
|
||||
@@ -294,8 +260,6 @@ Transform find config object for retrieval.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Omit","type":"Omit<[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)<[Swap](../../entities/classes/entities.Swap.mdx)>, \"select\">","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"cartRelations","type":"`undefined` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cartSelects","type":"`undefined` \\| keyof [Cart](../../entities/classes/entities.Cart.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"select","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Update the swap record.
|
||||
@@ -308,8 +272,6 @@ Update the swap record.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[Swap](../../entities/classes/entities.Swap.mdx)>","optional":false,"defaultValue":"","description":"updated swap record","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
-24
@@ -50,8 +50,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### authorizePayment
|
||||
|
||||
#### Parameters
|
||||
@@ -62,8 +60,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### cancelPayment
|
||||
|
||||
#### Parameters
|
||||
@@ -74,8 +70,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### capturePayment
|
||||
|
||||
#### Parameters
|
||||
@@ -86,8 +80,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createPayment
|
||||
|
||||
#### Parameters
|
||||
@@ -98,8 +90,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### deletePayment
|
||||
|
||||
#### Parameters
|
||||
@@ -110,8 +100,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getPaymentData
|
||||
|
||||
#### Parameters
|
||||
@@ -122,8 +110,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getStatus
|
||||
|
||||
#### Parameters
|
||||
@@ -134,8 +120,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### refundPayment
|
||||
|
||||
#### Parameters
|
||||
@@ -146,8 +130,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -158,8 +140,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updatePayment
|
||||
|
||||
#### Parameters
|
||||
@@ -170,8 +150,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### updatePaymentData
|
||||
|
||||
#### Parameters
|
||||
@@ -182,8 +160,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Record<string, unknown>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### clearLineItemsTaxLines
|
||||
|
||||
#### Parameters
|
||||
@@ -64,8 +62,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### clearTaxLines
|
||||
|
||||
#### Parameters
|
||||
@@ -76,8 +72,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createShippingTaxLines
|
||||
|
||||
Persists the tax lines relevant for a shipping method to the database. Used
|
||||
@@ -91,8 +85,6 @@ for return shipping methods.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### createTaxLines
|
||||
|
||||
Persists the tax lines relevant for an order to the database.
|
||||
@@ -105,8 +97,6 @@ Persists the tax lines relevant for an order to the database.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the newly created tax lines","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getCacheKey
|
||||
|
||||
The cache key to get cache hits by.
|
||||
@@ -119,8 +109,6 @@ The cache key to get cache hits by.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"the cache key to use for the id set","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getRegionRatesForProduct
|
||||
|
||||
Gets the tax rates configured for a product. The rates are cached between
|
||||
@@ -134,8 +122,6 @@ calls.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<Map<string, [TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]>>","optional":false,"defaultValue":"","description":"the tax rates configured for the shipping option. A map by product id","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getRegionRatesForShipping
|
||||
|
||||
Gets the tax rates configured for a shipping option. The rates are cached
|
||||
@@ -149,8 +135,6 @@ between calls.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxServiceRate](../../medusa/types/medusa.TaxServiceRate.mdx)[]>","optional":false,"defaultValue":"","description":"the tax rates configured for the shipping option.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getShippingTaxLines
|
||||
|
||||
Gets the relevant tax lines for a shipping method. Note: this method
|
||||
@@ -165,8 +149,6 @@ persist the tax lines to the DB layer.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]>","optional":false,"defaultValue":"","description":"the computed tax lines","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getTaxLines
|
||||
|
||||
Gets the relevant tax lines for an order or cart. If an order is provided
|
||||
@@ -183,8 +165,6 @@ wish to persist the tax lines to the DB layer.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<([LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx))[]>","optional":false,"defaultValue":"","description":"the computed tax lines","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getTaxLinesMap
|
||||
|
||||
Return a map of tax lines for line items and shipping methods
|
||||
@@ -195,9 +175,7 @@ Return a map of tax lines for line items and shipping methods
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TaxLinesMaps>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TaxLinesMaps>","optional":false,"defaultValue":"","description":"Return a map of tax lines for line items and shipping methods","expandable":false,"children":[]}]} />
|
||||
|
||||
### list
|
||||
|
||||
@@ -205,8 +183,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### registerInstalledProviders
|
||||
|
||||
#### Parameters
|
||||
@@ -217,8 +193,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveProvider
|
||||
|
||||
Retrieves the relevant tax provider for the given region.
|
||||
@@ -229,9 +203,7 @@ Retrieves the relevant tax provider for the given region.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ITaxService","type":"`object`","description":"Interface to be implemented by tax provider plugins. The interface defines a\nsingle method `getTaxLines` that returns numerical rates to apply to line\nitems and shipping methods.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
<ParameterTypes parameters={[{"name":"ITaxService","type":"`object`","description":"## Overview\n\nA tax provider is used to retrieve the tax lines in a cart. The Medusa backend provides a default `system` provider. You can create your own tax provider,\neither in a plugin or directly in your Medusa backend, then use it in any region.\n\nA tax provider class is defined in a TypeScript or JavaScript file under the `src/services` directory and the class must extend the\n`AbstractTaxService` class imported from `@medusajs/medusa`. The file's name is the tax provider's class name as a slug and without the word `Service`.\n\nFor example, you can create the file `src/services/my-tax.ts` with the following content:\n\n```ts title=\"src/services/my-tax.ts\"\nimport {\n AbstractTaxService,\n ItemTaxCalculationLine,\n ShippingTaxCalculationLine,\n TaxCalculationContext,\n} from \"@medusajs/medusa\"\nimport {\n ProviderTaxLine,\n} from \"@medusajs/medusa/dist/types/tax-service\"\n\nclass MyTaxService extends AbstractTaxService {\n async getTaxLines(\n itemLines: ItemTaxCalculationLine[],\n shippingLines: ShippingTaxCalculationLine[],\n context: TaxCalculationContext):\n Promise<ProviderTaxLine[]> {\n throw new Error(\"Method not implemented.\")\n }\n}\n\nexport default MyTaxService\n```\n\n---\n\n## Identifier Property\n\nThe `TaxProvider` entity has 2 properties: `identifier` and `is_installed`. The `identifier` property in the tax provider service is used when the tax provider is added to the database.\n\nThe value of this property is also used to reference the tax provider throughout Medusa. For example, it is used to [change the tax provider](https://docs.medusajs.com/modules/taxes/admin/manage-tax-settings#change-tax-provider-of-a-region) to a region.\n\n```ts title=\"src/services/my-tax.ts\"\nclass MyTaxService extends AbstractTaxService {\n static identifier = \"my-tax\"\n // ...\n}\n```\n\n---","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
@@ -243,8 +215,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -42,8 +42,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductTaxRate](../../entities/classes/entities.ProductTaxRate.mdx) \\| [ProductTaxRate](../../entities/classes/entities.ProductTaxRate.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addToProductType
|
||||
|
||||
#### Parameters
|
||||
@@ -54,8 +52,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ProductTypeTaxRate](../../entities/classes/entities.ProductTypeTaxRate.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### addToShippingOption
|
||||
|
||||
#### Parameters
|
||||
@@ -66,8 +62,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[ShippingTaxRate](../../entities/classes/entities.ShippingTaxRate.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
Wraps some work within a transactional block. If the service already has
|
||||
@@ -86,8 +80,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
@@ -98,8 +90,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxRate](../../entities/classes/entities.TaxRate.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
@@ -110,8 +100,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -122,8 +110,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
#### Parameters
|
||||
@@ -134,8 +120,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[[TaxRate](../../entities/classes/entities.TaxRate.mdx)[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listByProduct
|
||||
|
||||
#### Parameters
|
||||
@@ -146,8 +130,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### listByShippingOption
|
||||
|
||||
#### Parameters
|
||||
@@ -158,8 +140,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxRate](../../entities/classes/entities.TaxRate.mdx)[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeFromProduct
|
||||
|
||||
#### Parameters
|
||||
@@ -170,8 +150,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeFromProductType
|
||||
|
||||
#### Parameters
|
||||
@@ -182,8 +160,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### removeFromShippingOption
|
||||
|
||||
#### Parameters
|
||||
@@ -194,8 +170,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
#### Parameters
|
||||
@@ -206,8 +180,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxRate](../../entities/classes/entities.TaxRate.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -218,8 +190,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
@@ -230,8 +200,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxRate](../../entities/classes/entities.TaxRate.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -16,7 +16,7 @@ ___
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[{"name":"configModule_","type":"[ConfigModule](../../medusa/types/medusa.ConfigModule-1.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"RESOLUTION_KEY","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"configModule_","type":"[ConfigModule](../../medusa/interfaces/medusa.ConfigModule-1.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"RESOLUTION_KEY","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
@@ -32,8 +32,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### verifyToken
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -54,8 +54,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### calculateDiscount\_
|
||||
|
||||
Calculates either fixed or percentage discount of a variant
|
||||
@@ -72,8 +70,6 @@ Calculates either fixed or percentage discount of a variant
|
||||
|
||||
- in favour of DiscountService.calculateDiscountForLineItem
|
||||
|
||||
___
|
||||
|
||||
### getAllocationItemDiscounts
|
||||
|
||||
If the rule of a discount has allocation="item", then we need
|
||||
@@ -90,8 +86,6 @@ alongside the variant on which the discount was applied.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"LineDiscount[]","type":"`LineDiscount`[]","optional":false,"defaultValue":"","description":"array of triples of lineitem, variant and applied discount","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getAllocationMap
|
||||
|
||||
Gets a map of discounts and gift cards that apply to line items in an
|
||||
@@ -106,8 +100,6 @@ applies to a specific line item.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[LineAllocationsMap](../../medusa/types/medusa.LineAllocationsMap.mdx)>","optional":false,"defaultValue":"","description":"the allocation map for the line items in the cart or order.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getCalculationContext
|
||||
|
||||
Prepares the calculation context for a tax total calculation.
|
||||
@@ -120,8 +112,6 @@ Prepares the calculation context for a tax total calculation.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[TaxCalculationContext](../../medusa/types/medusa.TaxCalculationContext.mdx)>","optional":false,"defaultValue":"","description":"the tax calculation context","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getDiscountTotal
|
||||
|
||||
Calculates the total discount amount for each of the different supported
|
||||
@@ -135,8 +125,6 @@ discount types. If discounts aren't present or invalid returns 0.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the total discounts amount","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getGiftCardTotal
|
||||
|
||||
Gets the gift card amount on a cart or order.
|
||||
@@ -149,8 +137,6 @@ Gets the gift card amount on a cart or order.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"the gift card amount applied to the cart or order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getGiftCardableAmount
|
||||
|
||||
Gets the amount that can be gift carded on a cart. In regions where gift
|
||||
@@ -164,8 +150,6 @@ cards are taxable this amount should exclude taxes.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the gift card amount applied to the cart or order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineDiscounts
|
||||
|
||||
Returns the discount amount allocated to the line items of an order.
|
||||
@@ -178,8 +162,6 @@ Returns the discount amount allocated to the line items of an order.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"LineDiscountAmount[]","type":"`LineDiscountAmount`[]","optional":false,"defaultValue":"","description":"the allocations that the discount has on the items in the cart or\n order","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemAdjustmentsTotal
|
||||
|
||||
#### Parameters
|
||||
@@ -190,8 +172,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemDiscountAdjustment
|
||||
|
||||
#### Parameters
|
||||
@@ -202,8 +182,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemRefund
|
||||
|
||||
The amount that can be refunded for a given line item.
|
||||
@@ -216,8 +194,6 @@ The amount that can be refunded for a given line item.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the line item refund amount.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemTotal
|
||||
|
||||
Gets a total for a line item. The total can take gift cards, discounts and
|
||||
@@ -231,8 +207,6 @@ taxes into account. This can be controlled through the options.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the line item total","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getLineItemTotals
|
||||
|
||||
Breaks down the totals related to a line item; these are the subtotal, the
|
||||
@@ -247,8 +221,6 @@ applied to a line item and the amount of tax applied to a line item.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<LineItemTotals>","optional":false,"defaultValue":"","description":"the breakdown of the line item totals","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getPaidTotal
|
||||
|
||||
Gets the total payments made on an order
|
||||
@@ -261,8 +233,6 @@ Gets the total payments made on an order
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"the total paid amount","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getRefundTotal
|
||||
|
||||
Calculates refund total of line items.
|
||||
@@ -277,8 +247,6 @@ apply the discount again before refunding them.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the calculated subtotal","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getRefundedTotal
|
||||
|
||||
Gets the total refund amount for an order.
|
||||
@@ -291,8 +259,6 @@ Gets the total refund amount for an order.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"the total refunded amount for an order.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getShippingMethodTotals
|
||||
|
||||
Gets the totals breakdown for a shipping method. Fetches tax lines if not
|
||||
@@ -306,8 +272,6 @@ already provided.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<ShippingMethodTotals>","optional":false,"defaultValue":"","description":"An object that breaks down the totals for the shipping method","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getShippingTotal
|
||||
|
||||
Calculates shipping total
|
||||
@@ -320,8 +284,6 @@ Calculates shipping total
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"shipping total","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getSubtotal
|
||||
|
||||
Calculates subtotal of a given cart or order.
|
||||
@@ -334,8 +296,6 @@ Calculates subtotal of a given cart or order.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the calculated subtotal","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getSwapTotal
|
||||
|
||||
The total paid for swaps. May be negative in case of negative swap
|
||||
@@ -349,8 +309,6 @@ difference.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"the swap total","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getTaxTotal
|
||||
|
||||
Calculates tax total
|
||||
@@ -364,8 +322,6 @@ Currently based on the Danish tax system
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<null \\| number>","optional":false,"defaultValue":"","description":"tax total","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### getTotal
|
||||
|
||||
Calculates total of a given cart or order.
|
||||
@@ -378,8 +334,6 @@ Calculates total of a given cart or order.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<number>","optional":false,"defaultValue":"","description":"the calculated subtotal","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### rounded
|
||||
|
||||
Rounds a number using Math.round.
|
||||
@@ -392,8 +346,6 @@ Rounds a number using Math.round.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"the rounded value","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -404,8 +356,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -52,8 +52,6 @@ transaction manager is created.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<TResult>","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
Creates a user with username being validated.
|
||||
@@ -67,8 +65,6 @@ Fails if email is not a valid format.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[User](../../entities/classes/entities.User.mdx)>","optional":false,"defaultValue":"","description":"the result of create","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
Deletes a user from a given user id.
|
||||
@@ -81,8 +77,6 @@ Deletes a user from a given user id.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"the result of the delete operation.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### generateResetPasswordToken
|
||||
|
||||
Generate a JSON Web token, that will be sent to a user, that wishes to
|
||||
@@ -99,8 +93,6 @@ is always 15 minutes.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"the generated JSON web token","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### hashPassword\_
|
||||
|
||||
Hashes a password
|
||||
@@ -113,8 +105,6 @@ Hashes a password
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<string>","optional":false,"defaultValue":"","description":"hashed password","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
@@ -125,8 +115,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[User](../../entities/classes/entities.User.mdx)[]>","optional":false,"defaultValue":"","description":"the result of the find operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
Gets a user by id.
|
||||
@@ -140,8 +128,6 @@ Throws in case of DB Error and if user was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[User](../../entities/classes/entities.User.mdx)>","optional":false,"defaultValue":"","description":"the user document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByApiToken
|
||||
|
||||
Gets a user by api token.
|
||||
@@ -155,8 +141,6 @@ Throws in case of DB Error and if user was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[User](../../entities/classes/entities.User.mdx)>","optional":false,"defaultValue":"","description":"the user document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### retrieveByEmail
|
||||
|
||||
Gets a user by email.
|
||||
@@ -170,8 +154,6 @@ Throws in case of DB Error and if user was not found.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[User](../../entities/classes/entities.User.mdx)>","optional":false,"defaultValue":"","description":"the user document.","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### setPassword\_
|
||||
|
||||
Sets a password for a user
|
||||
@@ -186,8 +168,6 @@ password does not work.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[User](../../entities/classes/entities.User.mdx)>","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
#### Parameters
|
||||
@@ -198,8 +178,6 @@ ___
|
||||
|
||||
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
Updates a user.
|
||||
@@ -212,8 +190,6 @@ Updates a user.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Promise","type":"Promise<[User](../../entities/classes/entities.User.mdx)>","optional":false,"defaultValue":"","description":"the result of create","expandable":false,"children":[]}]} />
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
Reference in new issue
Block a user