asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
ee58c588f1be10a2f6ee16b6d8fdbbdd1462c219
medusa-store/docs/content/references/services/classes/CartService.md
Shahed Nasser e134f6d237 chore: fixed commit branch on generate reference action (#1857) 
* fixed commit branch

* fixes after yarn upgrade
2022-07-15 18:08:07 +03:00

22 KiB
Raw Blame History

Class: CartService

Hierarchy

Constructors

constructor

• new CartService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService<CartService&gt;.constructor

Defined in

services/cart.ts:107

Properties

addressRepository_

• Protected Readonly addressRepository_: typeof AddressRepository

Defined in

services/cart.ts:87

cartRepository_

• Protected Readonly cartRepository_: typeof CartRepository

Defined in

services/cart.ts:86

configModule

• Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

customShippingOptionService_

• Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

services/cart.ts:103

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

services/cart.ts:96

discountService_

• Protected Readonly discountService_: DiscountService

Defined in

services/cart.ts:98

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

services/cart.ts:90

giftCardService_

• Protected Readonly giftCardService_: GiftCardService

Defined in

services/cart.ts:99

inventoryService_

• Protected Readonly inventoryService_: InventoryService

Defined in

services/cart.ts:102

lineItemAdjustmentService_

• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

services/cart.ts:105

lineItemRepository_

• Protected Readonly lineItemRepository_: typeof LineItemRepository

Defined in

services/cart.ts:89

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

services/cart.ts:94

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/cart.ts:82

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

services/cart.ts:95

paymentSessionRepository_

• Protected Readonly paymentSessionRepository_: typeof PaymentSessionRepository

Defined in

services/cart.ts:88

priceSelectionStrategy_

• Protected Readonly priceSelectionStrategy_: IPriceSelectionStrategy

Defined in

services/cart.ts:104

productService_

• Protected Readonly productService_: ProductService

Defined in

services/cart.ts:92

productVariantService_

• Protected Readonly productVariantService_: ProductVariantService

Defined in

services/cart.ts:91

regionService_

• Protected Readonly regionService_: RegionService

Defined in

services/cart.ts:93

shippingMethodRepository_

• Protected Readonly shippingMethodRepository_: typeof ShippingMethodRepository

Defined in

services/cart.ts:85

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

services/cart.ts:97

taxProviderService_

• Protected Readonly taxProviderService_: TaxProviderService

Defined in

services/cart.ts:100

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

services/cart.ts:101

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/cart.ts:83

Events

▪ Static Readonly Events: Object

Type declaration

Name Type
CREATED string
CUSTOMER_UPDATED string
UPDATED string

Defined in

services/cart.ts:76

Methods

addLineItem

▸ addLineItem(cartId, lineItem): Promise<Cart>

Parameters

Name Type Description
cartId string
lineItem LineItem

Returns

Promise<Cart>

Defined in

services/cart.ts:533

addShippingMethod

▸ addShippingMethod(cartId, optionId, data?): Promise<Cart>

Parameters

Name Type Description
cartId string
optionId string
data Record<string, unknown>

Returns

Promise<Cart>

Defined in

services/cart.ts:1539

adjustFreeShipping_

▸ Protected adjustFreeShipping_(cart, shouldAdd): Promise<void>

Parameters

Name Type Description
cart Cart
shouldAdd boolean

Returns

Promise<void>

Defined in

services/cart.ts:685

applyDiscount

▸ applyDiscount(cart, discountCode): Promise<void>

Parameters

Name Type Description
cart Cart
discountCode string

Returns

Promise<void>

Defined in

services/cart.ts:1056

applyGiftCard_

▸ Protected applyGiftCard_(cart, code): Promise<void>

Parameters

Name Type
cart Cart
code string

Returns

Promise<void>

Defined in

services/cart.ts:1020

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

authorizePayment

▸ authorizePayment(cartId, context?): Promise<Cart>

Parameters

Name Type Description
cartId string
context Record<string, unknown>

Returns

Promise<Cart>

Defined in

services/cart.ts:1195

create

▸ create(data): Promise<Cart>

Parameters

Name Type Description
data CartCreateProps

Returns

Promise<Cart>

Defined in

services/cart.ts:334

createOrFetchUserFromEmail_

▸ Protected createOrFetchUserFromEmail_(email): Promise<Customer>

Parameters

Name Type Description
email string

Returns

Promise<Customer>

Defined in

services/cart.ts:898

createTaxLines

▸ createTaxLines(id): Promise<Cart>

Parameters

Name Type
id string

Returns

Promise<Cart>

Defined in

services/cart.ts:1940

decorateTotals_

▸ Protected decorateTotals_(cart, totalsToSelect, options?): Promise<Cart>

Parameters

Name Type
cart Cart
totalsToSelect TotalField[]
options TotalsConfig

Returns

Promise<Cart>

Defined in

services/cart.ts:209

delete

▸ delete(cartId): Promise<Cart>

Parameters

Name Type Description
cartId string

Returns

Promise<Cart>

Defined in

services/cart.ts:1855

deleteMetadata

▸ deleteMetadata(cartId, key): Promise<Cart>

Parameters

Name Type Description
cartId string
key string

Returns

Promise<Cart>

Defined in

services/cart.ts:1997

deletePaymentSession

▸ deletePaymentSession(cartId, providerId): Promise<Cart>

Parameters

Name Type Description
cartId string
providerId string

Returns

Promise<Cart>

Defined in

services/cart.ts:1447

findCustomShippingOption

▸ findCustomShippingOption(cartCustomShippingOptions, optionId): undefined | CustomShippingOption

Parameters

Name Type Description
cartCustomShippingOptions CustomShippingOption[]
optionId string

Returns

undefined | CustomShippingOption

Defined in

services/cart.ts:1643

list

▸ list(selector, config?): Promise<Cart[]>

Parameters

Name Type Description
selector FilterableCartProps
config FindConfig<Cart>

Returns

Promise<Cart[]>

Defined in

services/cart.ts:259

refreshAdjustments_

▸ Protected refreshAdjustments_(cart): Promise<void>

Parameters

Name Type
cart Cart

Returns

Promise<void>

Defined in

services/cart.ts:1971

refreshPaymentSession

▸ refreshPaymentSession(cartId, providerId): Promise<Cart>

Parameters

Name Type Description
cartId string
providerId string

Returns

Promise<Cart>

Defined in

services/cart.ts:1495

removeDiscount

▸ removeDiscount(cartId, discountCode): Promise<Cart>

Parameters

Name Type Description
cartId string
discountCode string

Returns

Promise<Cart>

Defined in

services/cart.ts:1116

removeLineItem

▸ removeLineItem(cartId, lineItemId): Promise<Cart>

Parameters

Name Type Description
cartId string
lineItemId string

Returns

Promise<Cart>

Defined in

services/cart.ts:437

retrieve

▸ retrieve(cartId, options?, totalsConfig?): Promise<Cart>

Parameters

Name Type Description
cartId string
options FindConfig<Cart>
totalsConfig TotalsConfig

Returns

Promise<Cart>

Defined in

services/cart.ts:282

setMetadata

▸ setMetadata(cartId, key, value): Promise<Cart>

Parameters

Name Type Description
cartId string
key string
value string | number

Returns

Promise<Cart>

Defined in

services/cart.ts:1898

setPaymentSession

▸ setPaymentSession(cartId, providerId): Promise<Cart>

Parameters

Name Type Description
cartId string
providerId string

Returns

Promise<Cart>

Defined in

services/cart.ts:1266

setPaymentSessions

▸ setPaymentSessions(cartOrCartId): Promise<void>

Parameters

Name Type Description
cartOrCartId string | Cart

Returns

Promise<void>

Defined in

services/cart.ts:1339

setRegion_

▸ Protected setRegion_(cart, regionId, countryCode): Promise<void>

Parameters

Name Type Description
cart Cart
regionId string
countryCode null | string

Returns

Promise<void>

Defined in

services/cart.ts:1722

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

transformQueryForTotals_

▸ Protected transformQueryForTotals_(config): FindConfig<Cart> & { totalsToSelect: TotalField[] }

Parameters

Name Type
config FindConfig<Cart>

Returns

FindConfig<Cart> & { totalsToSelect: TotalField[] }

Defined in

services/cart.ts:158

update

▸ update(cartId, data): Promise<Cart>

Parameters

Name Type
cartId string
data CartUpdateProps

Returns

Promise<Cart>

Defined in

services/cart.ts:728

updateBillingAddress_

▸ Protected updateBillingAddress_(cart, addressOrId, addrRepo): Promise<void>

Parameters

Name Type Description
cart Cart
addressOrId string | AddressPayload | Partial<Address>
addrRepo AddressRepository

Returns

Promise<void>

Defined in

services/cart.ts:931

updateCustomerId_

▸ Protected updateCustomerId_(cart, customerId): Promise<void>

Parameters

Name Type Description
cart Cart
customerId string

Returns

Promise<void>

Defined in

services/cart.ts:880

updateLineItem

▸ updateLineItem(cartId, lineItemId, lineItemUpdate): Promise<Cart>

Parameters

Name Type Description
cartId string
lineItemId string
lineItemUpdate LineItemUpdate

Returns

Promise<Cart>

Defined in

services/cart.ts:620

updatePaymentSession

▸ updatePaymentSession(cartId, update): Promise<Cart>

Parameters

Name Type Description
cartId string
update object

Returns

Promise<Cart>

Defined in

services/cart.ts:1160

updateShippingAddress_

▸ Protected updateShippingAddress_(cart, addressOrId, addrRepo): Promise<void>

Parameters

Name Type Description
cart Cart
addressOrId string | AddressPayload | Partial<Address>
addrRepo AddressRepository

Returns

Promise<void>

Defined in

services/cart.ts:971

updateUnitPrices_

▸ Protected updateUnitPrices_(cart, regionId?, customer_id?): Promise<void>

Parameters

Name Type
cart Cart
regionId? string
customer_id? string

Returns

Promise<void>

Defined in

services/cart.ts:1662

validateLineItemShipping_

▸ Protected validateLineItemShipping_(shippingMethods, lineItem): boolean

Parameters

Name Type Description
shippingMethods ShippingMethod[]
lineItem LineItem

Returns

boolean

Defined in

services/cart.ts:503

withTransaction

▸ withTransaction(transactionManager?): CartService

Parameters

Name Type
transactionManager? EntityManager

Returns

CartService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16

Reference in New Issue View Git Blame Copy Permalink