--- displayed_sidebar: jsClientSidebar --- # Module: internal ## Namespaces - [EventEmitter](internal-8.EventEmitter.md) - [internal](internal-8.internal.md) - [internal](internal-8.internal-1.md) - [internal](internal-8.internal-2.md) - [internal](internal-8.internal-3.md) - [internal](internal-8.internal-4.md) ## Enumerations - [DefaultPriceType](../enums/internal-8.DefaultPriceType.md) - [DiscountConditionJoinTableForeignKey](../enums/internal-8.DiscountConditionJoinTableForeignKey.md) - [FulfillmentStatus](../enums/internal-8.FulfillmentStatus.md) - [MODULE\_RESOURCE\_TYPE](../enums/internal-8.MODULE_RESOURCE_TYPE.md) - [OrderStatus](../enums/internal-8.OrderStatus.md) - [PaymentStatus](../enums/internal-8.PaymentStatus.md) ## Classes - [AbstractEventBusModuleService](../classes/internal-8.AbstractEventBusModuleService.md) - [AbstractSearchService](../classes/internal-8.AbstractSearchService.md) - [AdditionalItem](../classes/internal-8.AdditionalItem.md) - [AdditionalItem](../classes/internal-8.AdditionalItem-1.md) - [AdditionalItem](../classes/internal-8.AdditionalItem-2.md) - [AdminCreateCondition](../classes/internal-8.AdminCreateCondition.md) - [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) - [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) - [AdminGetDiscountsDiscountRuleParams](../classes/internal-8.AdminGetDiscountsDiscountRuleParams.md) - [AdminGetDiscountsParams](../classes/internal-8.AdminGetDiscountsParams.md) - [AdminListOrdersSelector](../classes/internal-8.AdminListOrdersSelector.md) - [AdminPostDiscountsDiscountConditions](../classes/internal-8.AdminPostDiscountsDiscountConditions.md) - [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md) - [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) - [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) - [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) - [AdminPostDiscountsDiscountConditionsParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md) - [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md) - [AdminPostDiscountsDiscountReq](../classes/internal-8.AdminPostDiscountsDiscountReq.md) - [AdminPostDiscountsDiscountRule](../classes/internal-8.AdminPostDiscountsDiscountRule.md) - [AdminPostDiscountsReq](../classes/internal-8.AdminPostDiscountsReq.md) - [AdminPriceSelectionParams](../classes/internal-8.AdminPriceSelectionParams.md) - [AdminProductCategoriesReqBase](../classes/internal-8.AdminProductCategoriesReqBase.md) - [AdminUpdateDiscountRule](../classes/internal-8.AdminUpdateDiscountRule.md) - [AdminUpsertCondition](../classes/internal-8.AdminUpsertCondition.md) - [AdminUpsertConditionsReq](../classes/internal-8.AdminUpsertConditionsReq.md) - [Blob](../classes/internal-8.Blob.md) - [CustomShippingOption](../classes/internal-8.CustomShippingOption.md) - [CustomerGroup](../classes/internal-8.CustomerGroup.md) - [CustomerGroup](../classes/internal-8.CustomerGroup-1.md) - [CustomerGroupUpdate](../classes/internal-8.CustomerGroupUpdate.md) - [Discount](../classes/internal-8.Discount.md) - [Discount](../classes/internal-8.Discount-1.md) - [Discount](../classes/internal-8.Discount-2.md) - [Discount](../classes/internal-8.Discount-3.md) - [Duplex](../classes/internal-8.Duplex.md) - [EventEmitter](../classes/internal-8.EventEmitter-1.md) - [FilterableCartProps](../classes/internal-8.FilterableCartProps.md) - [FilterableDiscountProps](../classes/internal-8.FilterableDiscountProps.md) - [FilterableLineItemAdjustmentProps](../classes/internal-8.FilterableLineItemAdjustmentProps.md) - [FilterableProductProps](../classes/internal-8.FilterableProductProps.md) - [FilterableProductVariantProps](../classes/internal-8.FilterableProductVariantProps.md) - [FlagRouter](../classes/internal-8.FlagRouter.md) - [FulfillmentService](../classes/internal-8.FulfillmentService.md) - [GiftCard](../classes/internal-8.GiftCard.md) - [GiftCard](../classes/internal-8.GiftCard-1.md) - [Image](../classes/internal-8.Image.md) - [Item](../classes/internal-8.Item.md) - [Item](../classes/internal-8.Item-1.md) - [Item](../classes/internal-8.Item-2.md) - [Item](../classes/internal-8.Item-3.md) - [Item](../classes/internal-8.Item-4.md) - [Item](../classes/internal-8.Item-5.md) - [Item](../classes/internal-8.Item-6.md) - [MedusaError](../classes/internal-8.MedusaError.md) - [NotificationProvider](../classes/internal-8.NotificationProvider.md) - [OptionRequirement](../classes/internal-8.OptionRequirement.md) - [OptionRequirement](../classes/internal-8.OptionRequirement-1.md) - [OrdersReturnItem](../classes/internal-8.OrdersReturnItem.md) - [PassThrough](../classes/internal-8.PassThrough.md) - [PaymentMethod](../classes/internal-8.PaymentMethod.md) - [PaymentService](../classes/internal-8.PaymentService.md) - [PriceSelectionParams](../classes/internal-8.PriceSelectionParams.md) - [ProductBatchProductCategory](../classes/internal-8.ProductBatchProductCategory.md) - [ProductBatchSalesChannel](../classes/internal-8.ProductBatchSalesChannel.md) - [ProductOptionReq](../classes/internal-8.ProductOptionReq.md) - [ProductProductCategoryReq](../classes/internal-8.ProductProductCategoryReq.md) - [ProductSalesChannelReq](../classes/internal-8.ProductSalesChannelReq.md) - [ProductTagReq](../classes/internal-8.ProductTagReq.md) - [ProductTypeReq](../classes/internal-8.ProductTypeReq.md) - [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq.md) - [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq-1.md) - [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq-2.md) - [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq-3.md) - [ProductVariantPricesCreateReq](../classes/internal-8.ProductVariantPricesCreateReq.md) - [ProductVariantPricesUpdateReq](../classes/internal-8.ProductVariantPricesUpdateReq.md) - [ProductVariantReq](../classes/internal-8.ProductVariantReq.md) - [ProductVariantReq](../classes/internal-8.ProductVariantReq-1.md) - [Readable](../classes/internal-8.Readable.md) - [ReadableBase](../classes/internal-8.ReadableBase.md) - [ReturnItem](../classes/internal-8.ReturnItem.md) - [ReturnShipping](../classes/internal-8.ReturnShipping.md) - [ReturnShipping](../classes/internal-8.ReturnShipping-1.md) - [ReturnShipping](../classes/internal-8.ReturnShipping-2.md) - [ReturnShipping](../classes/internal-8.ReturnShipping-3.md) - [ShippingMethod](../classes/internal-8.ShippingMethod.md) - [ShippingMethod](../classes/internal-8.ShippingMethod-1.md) - [ShippingMethod](../classes/internal-8.ShippingMethod-2.md) - [ShippingMethod](../classes/internal-8.ShippingMethod-3.md) - [StockLocationAddress](../classes/internal-8.StockLocationAddress.md) - [StockLocationAddress](../classes/internal-8.StockLocationAddress-1.md) - [Stream](../classes/internal-8.Stream.md) - [Tag](../classes/internal-8.Tag.md) - [Transform](../classes/internal-8.Transform.md) - [WritableBase](../classes/internal-8.WritableBase.md) - [internal](../classes/internal-8.internal-5.md) ## Interfaces - [ArrayBufferView](../interfaces/internal-8.ArrayBufferView.md) - [ArrayLike](../interfaces/internal-8.ArrayLike.md) - [AsyncGenerator](../interfaces/internal-8.AsyncGenerator.md) - [AsyncGeneratorFunction](../interfaces/internal-8.AsyncGeneratorFunction.md) - [AsyncIterable](../interfaces/internal-8.AsyncIterable.md) - [AsyncIterableIterator](../interfaces/internal-8.AsyncIterableIterator.md) - [AsyncIterator](../interfaces/internal-8.AsyncIterator.md) - [BlobOptions](../interfaces/internal-8.BlobOptions.md) - [Buffer](../interfaces/internal-8.Buffer.md) - [BufferConstructor](../interfaces/internal-8.BufferConstructor.md) - [CallSite](../interfaces/internal-8.CallSite.md) - [CreateNoteInput](../interfaces/internal-8.CreateNoteInput.md) - [CreateUserInput](../interfaces/internal-8.CreateUserInput.md) - [DuplexOptions](../interfaces/internal-8.DuplexOptions.md) - [ErrnoException](../interfaces/internal-8.ErrnoException.md) - [Error](../interfaces/internal-8.Error.md) - [EventEmitter](../interfaces/internal-8.EventEmitter-2.md) - [EventEmitterOptions](../interfaces/internal-8.EventEmitterOptions.md) - [FindConfig](../interfaces/internal-8.FindConfig.md) - [ICacheService](../interfaces/internal-8.ICacheService.md) - [IEventBusModuleService](../interfaces/internal-8.IEventBusModuleService.md) - [IEventBusService](../interfaces/internal-8.IEventBusService.md) - [IFlagRouter](../interfaces/internal-8.IFlagRouter.md) - [IInventoryService](../interfaces/internal-8.IInventoryService.md) - [ISearchService](../interfaces/internal-8.ISearchService.md) - [IStockLocationService](../interfaces/internal-8.IStockLocationService.md) - [ITransactionBaseService](../interfaces/internal-8.ITransactionBaseService.md) - [Iterable](../interfaces/internal-8.Iterable.md) - [IterableIterator](../interfaces/internal-8.IterableIterator.md) - [Iterator](../interfaces/internal-8.Iterator.md) - [IteratorReturnResult](../interfaces/internal-8.IteratorReturnResult.md) - [IteratorYieldResult](../interfaces/internal-8.IteratorYieldResult.md) - [JoinerServiceConfig](../interfaces/internal-8.JoinerServiceConfig.md) - [JoinerServiceConfigAlias](../interfaces/internal-8.JoinerServiceConfigAlias.md) - [Logger](../interfaces/internal-8.Logger.md) - [NumericalComparisonOperator](../interfaces/internal-8.NumericalComparisonOperator.md) - [Object](../interfaces/internal-8.Object.md) - [PromiseLike](../interfaces/internal-8.PromiseLike.md) - [QueuingStrategy](../interfaces/internal-8.QueuingStrategy.md) - [QueuingStrategySize](../interfaces/internal-8.QueuingStrategySize.md) - [ReadWriteStream](../interfaces/internal-8.ReadWriteStream.md) - [ReadableByteStreamController](../interfaces/internal-8.ReadableByteStreamController.md) - [ReadableByteStreamControllerCallback](../interfaces/internal-8.ReadableByteStreamControllerCallback.md) - [ReadableStream](../interfaces/internal-8.ReadableStream.md) - [ReadableStream](../interfaces/internal-8.ReadableStream-1.md) - [ReadableStreamDefaultController](../interfaces/internal-8.ReadableStreamDefaultController.md) - [ReadableStreamDefaultReadDoneResult](../interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md) - [ReadableStreamDefaultReadValueResult](../interfaces/internal-8.ReadableStreamDefaultReadValueResult.md) - [ReadableStreamDefaultReader](../interfaces/internal-8.ReadableStreamDefaultReader.md) - [ReadableStreamErrorCallback](../interfaces/internal-8.ReadableStreamErrorCallback.md) - [ReadableStreamGenericReader](../interfaces/internal-8.ReadableStreamGenericReader.md) - [ReadableWritablePair](../interfaces/internal-8.ReadableWritablePair.md) - [SharedArrayBuffer](../interfaces/internal-8.SharedArrayBuffer.md) - [SharedArrayBufferConstructor](../interfaces/internal-8.SharedArrayBufferConstructor.md) - [StaticEventEmitterOptions](../interfaces/internal-8.StaticEventEmitterOptions.md) - [StreamPipeOptions](../interfaces/internal-8.StreamPipeOptions.md) - [StringComparisonOperator](../interfaces/internal-8.StringComparisonOperator.md) - [TransformOptions](../interfaces/internal-8.TransformOptions.md) - [UnderlyingByteSource](../interfaces/internal-8.UnderlyingByteSource.md) - [UnderlyingSink](../interfaces/internal-8.UnderlyingSink.md) - [UnderlyingSinkAbortCallback](../interfaces/internal-8.UnderlyingSinkAbortCallback.md) - [UnderlyingSinkCloseCallback](../interfaces/internal-8.UnderlyingSinkCloseCallback.md) - [UnderlyingSinkStartCallback](../interfaces/internal-8.UnderlyingSinkStartCallback.md) - [UnderlyingSinkWriteCallback](../interfaces/internal-8.UnderlyingSinkWriteCallback.md) - [UnderlyingSource](../interfaces/internal-8.UnderlyingSource.md) - [UnderlyingSourceCancelCallback](../interfaces/internal-8.UnderlyingSourceCancelCallback.md) - [UnderlyingSourcePullCallback](../interfaces/internal-8.UnderlyingSourcePullCallback.md) - [UnderlyingSourceStartCallback](../interfaces/internal-8.UnderlyingSourceStartCallback.md) - [UpdateUserInput](../interfaces/internal-8.UpdateUserInput.md) - [WritableStream](../interfaces/internal-8.WritableStream.md) - [WritableStream](../interfaces/internal-8.WritableStream-1.md) - [WritableStreamDefaultController](../interfaces/internal-8.WritableStreamDefaultController.md) - [WritableStreamDefaultWriter](../interfaces/internal-8.WritableStreamDefaultWriter.md) - [\_DOMEventTarget](../interfaces/internal-8._DOMEventTarget.md) - [\_NodeEventTarget](../interfaces/internal-8._NodeEventTarget.md) ## References ### Abortable Re-exports [Abortable](../interfaces/internal-8.EventEmitter.Abortable.md) ___ ### ReadableOptions Re-exports [ReadableOptions](../interfaces/internal-8.internal-2.ReadableOptions.md) ___ ### WritableOptions Re-exports [WritableOptions](../interfaces/internal-8.internal-2.WritableOptions.md) ## Enumeration Members ### DEFAULT • **DEFAULT**: ``"default"`` #### Defined in packages/medusa/dist/interfaces/price-selection-strategy.d.ts:45 ___ ### EXTERNAL • **EXTERNAL**: ``"external"`` #### Defined in packages/types/dist/modules-sdk/index.d.ts:11 ___ ### INTERNAL • **INTERNAL**: ``"internal"`` #### Defined in packages/types/dist/modules-sdk/index.d.ts:10 ## Type Aliases ### AddOrderEditLineItemInput Ƭ **AddOrderEditLineItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `quantity` | `number` | | `variant_id` | `string` | #### Defined in packages/medusa/dist/types/order-edit.d.ts:6 ___ ### AdjustmentContext Ƭ **AdjustmentContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `variant` | { `product_id`: `string` } | | `variant.product_id` | `string` | #### Defined in packages/medusa/dist/services/line-item-adjustment.d.ts:14 ___ ### AdminDiscountConditionsRes Ƭ **AdminDiscountConditionsRes**: `Object` **`Schema`** AdminDiscountConditionsRes type: object x-expanded-relations: field: discount_condition relations: - discount_rule required: - discount_condition properties: discount_condition: description: "Discount condition details." $ref: "#/components/schemas/DiscountCondition" #### Type declaration | Name | Type | | :------ | :------ | | `discount_condition` | [`DiscountCondition`](../classes/internal-3.DiscountCondition.md) | #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:48 ___ ### AdminDiscountsListRes Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal-3.Discount.md)[] } **`Schema`** AdminDiscountsListRes type: object x-expanded-relations: field: discounts relations: - parent_discount - regions - rule - rule.conditions required: - discounts - count - offset - limit properties: discounts: type: array items: $ref: "#/components/schemas/Discount" count: type: integer description: The total number of items available offset: type: integer description: The number of discounts skipped when retrieving the discounts. limit: type: integer description: The number of items per page #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:129 ___ ### AdminDiscountsRes Ƭ **AdminDiscountsRes**: `Object` **`Schema`** AdminDiscountsRes type: object x-expanded-relations: field: discount relations: - parent_discount - regions - rule - rule.conditions eager: - regions.fulfillment_providers - regions.payment_providers required: - discount properties: discount: description: "Discount details." $ref: "#/components/schemas/Discount" #### Type declaration | Name | Type | | :------ | :------ | | `discount` | [`Discount`](../classes/internal-3.Discount.md) | #### Defined in packages/medusa/dist/api/routes/admin/discounts/index.d.ts:31 ___ ### AllocationMapOptions Ƭ **AllocationMapOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `exclude_discounts?` | `boolean` | | `exclude_gift_cards?` | `boolean` | #### Defined in packages/medusa/dist/services/totals.d.ts:54 ___ ### ArrayBufferLike Ƭ **ArrayBufferLike**: `ArrayBufferTypes`[keyof `ArrayBufferTypes`] #### Defined in docs-util/node_modules/typescript/lib/lib.es5.d.ts:1701 ___ ### ArrayBufferView Ƭ **ArrayBufferView**: [`TypedArray`](internal-8.md#typedarray) \| `DataView` #### Defined in packages/medusa-js/node_modules/@types/node/globals.d.ts:251 ___ ### AuthenticateResult Ƭ **AuthenticateResult**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customer?` | [`Customer`](../classes/internal-3.Customer.md) | | `error?` | `string` | | `success` | `boolean` | | `user?` | [`User`](../classes/internal-1.User.md) | #### Defined in packages/medusa/dist/types/auth.d.ts:2 ___ ### AvailabilityContext Ƭ **AvailabilityContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `inventoryLocationMap?` | `Map`<`string`, [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[]\> | | `variantInventoryMap?` | `Map`<`string`, [`ProductVariantInventoryItem`](../classes/internal-3.ProductVariantInventoryItem.md)[]\> | #### Defined in packages/medusa/dist/services/product-variant-inventory.d.ts:19 ___ ### BinaryLike Ƭ **BinaryLike**: `string` \| [`ArrayBufferView`](internal-8.md#arraybufferview) #### Defined in packages/medusa-js/node_modules/@types/node/crypto.d.ts:656 ___ ### BufferEncoding Ƭ **BufferEncoding**: ``"ascii"`` \| ``"utf8"`` \| ``"utf-8"`` \| ``"utf16le"`` \| ``"ucs2"`` \| ``"ucs-2"`` \| ``"base64"`` \| ``"base64url"`` \| ``"latin1"`` \| ``"binary"`` \| ``"hex"`` #### Defined in packages/medusa-js/node_modules/@types/node/buffer.d.ts:223 ___ ### CalculateOptionPriceInput Ƭ **CalculateOptionPriceInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `provider_id` | `string` | #### Defined in packages/medusa/dist/services/fulfillment-provider.d.ts:16 ___ ### CalculationContextData Ƭ **CalculationContextData**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `claims?` | [`ClaimOrder`](../classes/internal-3.ClaimOrder.md)[] | | `customer` | [`Customer`](../classes/internal-3.Customer.md) | | `discounts` | [`Discount`](../classes/internal-3.Discount.md)[] | | `items` | [`LineItem`](../classes/internal-3.LineItem.md)[] | | `region` | [`Region`](../classes/internal-3.Region.md) | | `shipping_address` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | | `shipping_methods?` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] | | `swaps?` | [`Swap`](../classes/internal-3.Swap.md)[] | #### Defined in packages/medusa/dist/types/totals.d.ts:2 ___ ### CalculationContextOptions Ƭ **CalculationContextOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `exclude_discounts?` | `boolean` | | `exclude_gift_cards?` | `boolean` | | `exclude_shipping?` | `boolean` | | `is_return?` | `boolean` | #### Defined in packages/medusa/dist/services/totals.d.ts:58 ___ ### CartCreateProps Ƭ **CartCreateProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `billing_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | | `billing_address_id?` | `string` | | `context?` | `object` | | `country_code?` | `string` | | `customer_id?` | `string` | | `discounts?` | [`Discount`](../classes/internal-8.Discount-3.md)[] | | `email?` | `string` | | `gift_cards?` | [`GiftCard`](../classes/internal-8.GiftCard-1.md)[] | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `region?` | [`Region`](../classes/internal-3.Region.md) | | `region_id?` | `string` | | `sales_channel_id?` | `string` | | `shipping_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | | `shipping_address_id?` | `string` | | `type?` | [`CartType`](../enums/internal-3.CartType.md) | #### Defined in packages/medusa/dist/types/cart.d.ts:31 ___ ### CartUpdateProps Ƭ **CartUpdateProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `billing_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) \| `string` | | `billing_address_id?` | `string` | | `completed_at?` | `Date` | | `context?` | `object` | | `country_code?` | `string` | | `customer_id?` | `string` | | `discounts?` | [`Discount`](../classes/internal-8.Discount-3.md)[] | | `email?` | `string` | | `gift_cards?` | [`GiftCard`](../classes/internal-8.GiftCard-1.md)[] | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `payment_authorized_at?` | `Date` \| ``null`` | | `region_id?` | `string` | | `sales_channel_id?` | `string` | | `shipping_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) \| `string` | | `shipping_address_id?` | `string` | #### Defined in packages/medusa/dist/types/cart.d.ts:48 ___ ### CategoryQueryParams Ƭ **CategoryQueryParams**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `value` | `string`[] | #### Defined in packages/medusa/dist/repositories/product.d.ts:5 ___ ### ClaimTypeValue Ƭ **ClaimTypeValue**: \`${ClaimType}\` #### Defined in packages/medusa/dist/types/claim.d.ts:3 ___ ### ConfigModule Ƭ **ConfigModule**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `featureFlags` | [`Record`](internal.md#record)<`string`, `boolean` \| `string`\> | | `modules?` | [`Record`](internal.md#record)<`string`, ``false`` \| `string` \| [`Partial`](internal-8.md#partial)<[`InternalModuleDeclaration`](internal-8.md#internalmoduledeclaration) \| [`ExternalModuleDeclaration`](internal-8.md#externalmoduledeclaration)\>\> | | `plugins` | ({ `options`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] | | `projectConfig` | [`ProjectConfigOptions`](internal-8.md#projectconfigoptions) | #### Defined in packages/types/dist/common/config-module.d.ts:39 ___ ### Constructor Ƭ **Constructor**<`T`\>: `Object` #### Type parameters | Name | | :------ | | `T` | #### Defined in packages/types/dist/modules-sdk/index.d.ts:5 ___ ### CreateAnalyticsConfig Ƭ **CreateAnalyticsConfig**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `anonymize` | `boolean` | | `opt_out` | `boolean` | #### Defined in packages/medusa/dist/types/analytics-config.d.ts:1 ___ ### CreateClaimInput Ƭ **CreateClaimInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `additional_items?` | [`CreateClaimItemAdditionalItemInput`](internal-8.md#createclaimitemadditionaliteminput)[] | | `claim_items` | [`CreateClaimItemInput`](internal-8.md#createclaimiteminput)[] | | `claim_order_id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `no_notification?` | `boolean` | | `order` | [`Order`](../classes/internal-3.Order.md) | | `refund_amount?` | `number` | | `return_location_id?` | `string` | | `return_shipping?` | [`CreateClaimReturnShippingInput`](internal-8.md#createclaimreturnshippinginput) | | `shipping_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) | | `shipping_address_id?` | `string` | | `shipping_methods?` | [`CreateClaimShippingMethodInput`](internal-8.md#createclaimshippingmethodinput)[] | | `type` | [`ClaimTypeValue`](internal-8.md#claimtypevalue) | #### Defined in packages/medusa/dist/types/claim.d.ts:4 ___ ### CreateClaimItemAdditionalItemInput Ƭ **CreateClaimItemAdditionalItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `quantity` | `number` | | `variant_id` | `string` | #### Defined in packages/medusa/dist/types/claim.d.ts:38 ___ ### CreateClaimItemInput Ƭ **CreateClaimItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `claim_order_id?` | `string` | | `images?` | `string`[] | | `item_id` | `string` | | `note?` | `string` | | `quantity` | `number` | | `reason` | [`ClaimReason`](../enums/internal-3.ClaimReason.md) | | `tags?` | `string`[] | #### Defined in packages/medusa/dist/types/claim.d.ts:29 ___ ### CreateClaimReturnShippingInput Ƭ **CreateClaimReturnShippingInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `option_id?` | `string` | | `price?` | `number` | #### Defined in packages/medusa/dist/types/claim.d.ts:19 ___ ### CreateClaimShippingMethodInput Ƭ **CreateClaimShippingMethodInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `id?` | `string` | | `option_id?` | `string` | | `price?` | `number` | #### Defined in packages/medusa/dist/types/claim.d.ts:23 ___ ### CreateCustomShippingOptionInput Ƭ **CreateCustomShippingOptionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cart_id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `price` | `number` | | `shipping_option_id` | `string` | #### Defined in packages/medusa/dist/types/shipping-options.d.ts:46 ___ ### CreateCustomerInput Ƭ **CreateCustomerInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `email` | `string` | | `first_name?` | `string` | | `has_account?` | `boolean` | | `last_name?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `password?` | `string` | | `password_hash?` | `string` | | `phone?` | `string` | #### Defined in packages/medusa/dist/types/customers.d.ts:7 ___ ### CreateDiscountInput Ƭ **CreateDiscountInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `code` | `string` | | `ends_at?` | `Date` | | `is_disabled` | `boolean` | | `is_dynamic` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `regions?` | `string`[] \| [`Region`](../classes/internal-3.Region.md)[] | | `rule` | [`CreateDiscountRuleInput`](internal-8.md#creatediscountruleinput) | | `starts_at?` | `Date` | | `usage_limit?` | `number` | | `valid_duration?` | `string` | #### Defined in packages/medusa/dist/types/discount.d.ts:57 ___ ### CreateDiscountRuleInput Ƭ **CreateDiscountRuleInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `allocation` | [`AllocationType`](../enums/internal-3.AllocationType.md) | | `conditions?` | [`DiscountConditionInput`](internal-8.md#discountconditioninput)[] | | `description?` | `string` | | `type` | [`DiscountRuleType`](../enums/internal-3.DiscountRuleType.md) | | `value` | `number` | #### Defined in packages/medusa/dist/types/discount.d.ts:50 ___ ### CreateDynamicDiscountInput Ƭ **CreateDynamicDiscountInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `code` | `string` | | `ends_at?` | `Date` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `usage_limit` | `number` | #### Defined in packages/medusa/dist/types/discount.d.ts:87 ___ ### CreateFulfillmentOrder Ƭ **CreateFulfillmentOrder**: [`Omit`](internal-1.md#omit)<[`ClaimOrder`](../classes/internal-3.ClaimOrder.md), ``"beforeInsert"``\> & { `billing_address`: [`Address`](../classes/internal-3.Address.md) ; `currency_code`: `string` ; `discounts`: [`Discount`](../classes/internal-3.Discount.md)[] ; `display_id`: `number` ; `email?`: `string` ; `is_claim?`: `boolean` ; `is_swap?`: `boolean` ; `items`: [`LineItem`](../classes/internal-3.LineItem.md)[] ; `no_notification`: `boolean` ; `payments`: [`Payment`](../classes/internal-3.Payment.md)[] ; `region?`: [`Region`](../classes/internal-3.Region.md) ; `region_id`: `string` ; `shipping_methods`: [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] ; `tax_rate`: `number` \| ``null`` } #### Defined in packages/medusa/dist/types/fulfillment.d.ts:15 ___ ### CreateGiftCardInput Ƭ **CreateGiftCardInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `balance?` | `number` | | `ends_at?` | `Date` | | `is_disabled?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `order_id?` | `string` | | `region_id` | `string` | | `tax_rate?` | `number` \| ``null`` | | `value?` | `number` | #### Defined in packages/medusa/dist/types/gift-card.d.ts:1 ___ ### CreateGiftCardTransactionInput Ƭ **CreateGiftCardTransactionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `created_at?` | `Date` | | `gift_card_id` | `string` | | `is_taxable?` | `boolean` | | `order_id` | `string` | | `tax_rate?` | `number` \| ``null`` | #### Defined in packages/medusa/dist/types/gift-card.d.ts:18 ___ ### CreateIdempotencyKeyInput Ƭ **CreateIdempotencyKeyInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `idempotency_key?` | `string` | | `request_method?` | `string` | | `request_params?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `request_path?` | `string` | #### Defined in packages/medusa/dist/types/idempotency-key.d.ts:1 ___ ### CreateInventoryItemInput Ƭ **CreateInventoryItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `description?` | `string` | | `height?` | `number` | | `hs_code?` | `string` | | `length?` | `number` | | `material?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `mid_code?` | `string` | | `origin_country?` | `string` | | `requires_shipping?` | `boolean` | | `sku?` | `string` | | `thumbnail?` | `string` | | `title?` | `string` | | `weight?` | `number` | | `width?` | `number` | #### Defined in packages/types/dist/inventory/common.d.ts:213 ___ ### CreateInventoryLevelInput Ƭ **CreateInventoryLevelInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `incoming_quantity?` | `number` | | `inventory_item_id` | `string` | | `location_id` | `string` | | `reserved_quantity?` | `number` | | `stocked_quantity` | `number` | #### Defined in packages/types/dist/inventory/common.d.ts:246 ___ ### CreateOauthInput Ƭ **CreateOauthInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `application_name` | `string` | | `display_name` | `string` | | `install_url?` | `string` | | `uninstall_url?` | `string` | #### Defined in packages/medusa/dist/types/oauth.d.ts:1 ___ ### CreateOrderEditInput Ƭ **CreateOrderEditInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `internal_note?` | `string` | | `order_id` | `string` | #### Defined in packages/medusa/dist/types/order-edit.d.ts:2 ___ ### CreateOrderEditItemChangeInput Ƭ **CreateOrderEditItemChangeInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `line_item_id?` | `string` | | `order_edit_id` | `string` | | `original_line_item_id?` | `string` | | `type` | [`OrderEditItemChangeType`](../enums/internal-3.OrderEditItemChangeType.md) | #### Defined in packages/medusa/dist/types/order-edit.d.ts:11 ___ ### CreatePaymentCollectionInput Ƭ **CreatePaymentCollectionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `created_by` | `string` | | `currency_code` | `string` | | `description?` | `string` | | `metadata?` | `any` | | `region_id` | `string` | | `type` | [`PaymentCollectionType`](../enums/internal-8.internal.PaymentCollectionType.md) | #### Defined in packages/medusa/dist/types/payment-collection.d.ts:2 ___ ### CreatePaymentInput Ƭ **CreatePaymentInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `cart_id?` | `string` | | `currency_code` | `string` | | `payment_session` | [`PaymentSession`](../classes/internal-3.PaymentSession.md) | | `provider_id?` | `string` | | `resource_id?` | `string` | #### Defined in packages/medusa/dist/types/payment.d.ts:19 ___ ### CreateProductCategoryInput Ƭ **CreateProductCategoryInput**: [`ProductCategoryInput`](internal-8.md#productcategoryinput) & { `name`: `string` } #### Defined in packages/medusa/dist/types/product-category.d.ts:11 ___ ### CreateProductCollection Ƭ **CreateProductCollection**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `handle?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `title` | `string` | #### Defined in packages/medusa/dist/types/product-collection.d.ts:1 ___ ### CreateProductInput Ƭ **CreateProductInput**: `Object` Service Level DTOs #### Type declaration | Name | Type | | :------ | :------ | | `categories?` | [`CreateProductProductCategoryInput`](internal-8.md#createproductproductcategoryinput)[] \| ``null`` | | `collection_id?` | `string` | | `description?` | `string` | | `discountable?` | `boolean` | | `external_id?` | `string` \| ``null`` | | `handle?` | `string` | | `height?` | `number` | | `hs_code?` | `string` | | `images?` | `string`[] | | `is_giftcard?` | `boolean` | | `length?` | `number` | | `material?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `mid_code?` | `string` | | `options?` | [`CreateProductProductOption`](internal-8.md#createproductproductoption)[] | | `origin_country?` | `string` | | `profile_id?` | `string` | | `sales_channels?` | [`CreateProductProductSalesChannelInput`](internal-8.md#createproductproductsaleschannelinput)[] \| ``null`` | | `status?` | [`ProductStatus`](../enums/internal-3.ProductStatus.md) | | `subtitle?` | `string` | | `tags?` | [`CreateProductProductTagInput`](internal-8.md#createproductproducttaginput)[] | | `thumbnail?` | `string` | | `title` | `string` | | `type?` | [`CreateProductProductTypeInput`](internal-8.md#createproductproducttypeinput) | | `variants?` | [`CreateProductProductVariantInput`](internal-8.md#createproductproductvariantinput)[] | | `weight?` | `number` | | `width?` | `number` | #### Defined in packages/medusa/dist/types/product.d.ts:38 ___ ### CreateProductProductCategoryInput Ƭ **CreateProductProductCategoryInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id` | `string` | #### Defined in packages/medusa/dist/types/product.d.ts:74 ___ ### CreateProductProductOption Ƭ **CreateProductProductOption**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `title` | `string` | #### Defined in packages/medusa/dist/types/product.d.ts:129 ___ ### CreateProductProductSalesChannelInput Ƭ **CreateProductProductSalesChannelInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id` | `string` | #### Defined in packages/medusa/dist/types/product.d.ts:71 ___ ### CreateProductProductTagInput Ƭ **CreateProductProductTagInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id?` | `string` | | `value` | `string` | #### Defined in packages/medusa/dist/types/product.d.ts:67 ___ ### CreateProductProductTypeInput Ƭ **CreateProductProductTypeInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id?` | `string` | | `value` | `string` | #### Defined in packages/medusa/dist/types/product.d.ts:77 ___ ### CreateProductProductVariantInput Ƭ **CreateProductProductVariantInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `allow_backorder?` | `boolean` | | `barcode?` | `string` | | `ean?` | `string` | | `height?` | `number` | | `hs_code?` | `string` | | `inventory_quantity?` | `number` | | `length?` | `number` | | `manage_inventory?` | `boolean` | | `material?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `mid_code?` | `string` | | `options?` | { `value`: `string` }[] | | `origin_country?` | `string` | | `prices?` | [`CreateProductProductVariantPriceInput`](internal-8.md#createproductproductvariantpriceinput)[] | | `sku?` | `string` | | `title` | `string` | | `upc?` | `string` | | `weight?` | `number` | | `width?` | `number` | #### Defined in packages/medusa/dist/types/product.d.ts:81 ___ ### CreateProductProductVariantPriceInput Ƭ **CreateProductProductVariantPriceInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `currency_code?` | `string` | | `max_quantity?` | `number` | | `min_quantity?` | `number` | | `region_id?` | `string` | #### Defined in packages/medusa/dist/types/product.d.ts:132 ___ ### CreateProductVariantInput Ƭ **CreateProductVariantInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `allow_backorder?` | `boolean` | | `barcode?` | `string` | | `ean?` | `string` | | `height?` | `number` | | `hs_code?` | `string` | | `inventory_quantity?` | `number` | | `length?` | `number` | | `manage_inventory?` | `boolean` | | `material?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `mid_code?` | `string` | | `options` | [`ProductVariantOption`](internal-8.md#productvariantoption)[] | | `origin_country?` | `string` | | `prices` | [`ProductVariantPrice`](internal-8.md#productvariantprice)[] | | `product_id?` | `string` | | `sku?` | `string` | | `title?` | `string` | | `upc?` | `string` | | `variant_rank?` | `number` | | `weight?` | `number` | | `width?` | `number` | #### Defined in packages/medusa/dist/types/product-variant.d.ts:21 ___ ### CreateRegionInput Ƭ **CreateRegionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `countries` | `string`[] | | `currency_code` | `string` | | `fulfillment_providers` | `string`[] | | `includes_tax?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name` | `string` | | `payment_providers` | `string`[] | | `tax_code?` | `string` | | `tax_rate` | `number` | #### Defined in packages/medusa/dist/types/region.d.ts:15 ___ ### CreateReservationItemInput Ƭ **CreateReservationItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `created_by?` | `string` | | `description?` | `string` | | `external_id?` | `string` | | `inventory_item_id` | `string` | | `line_item_id?` | `string` | | `location_id` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `quantity` | `number` | #### Defined in packages/types/dist/inventory/common.d.ts:229 ___ ### CreateReturnInput Ƭ **CreateReturnInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `claim_order_id?` | `string` | | `items?` | [`OrdersReturnItem`](internal-8.md#ordersreturnitem)[] | | `location_id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `no_notification?` | `boolean` | | `order_id` | `string` | | `refund_amount?` | `number` | | `shipping_method?` | { `option_id?`: `string` ; `price?`: `number` } | | `shipping_method.option_id?` | `string` | | `shipping_method.price?` | `number` | | `swap_id?` | `string` | #### Defined in packages/medusa/dist/types/return.d.ts:7 ___ ### CreateReturnReason Ƭ **CreateReturnReason**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `description?` | `string` | | `label` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `parent_return_reason_id?` | `string` | | `value` | `string` | #### Defined in packages/medusa/dist/types/return-reason.d.ts:1 ___ ### CreateReturnType Ƭ **CreateReturnType**: [`Omit`](internal-1.md#omit)<[`Return`](../classes/internal-3.Return.md), ``"beforeInsert"``\> #### Defined in packages/medusa/dist/types/fulfillment-provider.d.ts:6 ___ ### CreateSalesChannelInput Ƭ **CreateSalesChannelInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `description?` | `string` | | `is_disabled?` | `boolean` | | `name` | `string` | #### Defined in packages/medusa/dist/types/sales-channels.d.ts:1 ___ ### CreateShipmentConfig Ƭ **CreateShipmentConfig**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `location_id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `no_notification?` | `boolean` | #### Defined in packages/medusa/dist/types/fulfillment.d.ts:10 ___ ### CreateShippingMethod Ƭ **CreateShippingMethod**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cart_id?` | `string` | | `claim_order_id?` | `string` | | `data?` | `any` | | `draft_order_id?` | `string` | | `order_id?` | `string` | | `price?` | `number` | | `return_id?` | `string` | | `shipping_option_id?` | `string` | | `swap_id?` | `string` | #### Defined in packages/medusa/dist/types/shipping-options.d.ts:17 ___ ### CreateShippingMethodDto Ƭ **CreateShippingMethodDto**: [`CreateShippingMethod`](internal-8.md#createshippingmethod) & { `cart?`: [`Cart`](../classes/internal-3.Cart.md) ; `order?`: [`Order`](../classes/internal-3.Order.md) } #### Defined in packages/medusa/dist/types/shipping-options.d.ts:28 ___ ### CreateShippingOptionInput Ƭ **CreateShippingOptionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `admin_only?` | `boolean` | | `amount?` | `number` | | `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `includes_tax?` | `boolean` | | `is_return?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name` | `string` | | `price_type` | [`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md) | | `profile_id` | `string` | | `provider_id` | `string` | | `region_id` | `string` | | `requirements?` | [`ShippingOptionRequirement`](../classes/internal-3.ShippingOptionRequirement.md)[] | #### Defined in packages/medusa/dist/types/shipping-options.d.ts:32 ___ ### CreateShippingProfile Ƭ **CreateShippingProfile**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name` | `string` | | `type` | [`ShippingProfileType`](../enums/internal-3.ShippingProfileType.md) | #### Defined in packages/medusa/dist/types/shipping-profile.d.ts:2 ___ ### CreateStockLocationInput Ƭ **CreateStockLocationInput**: `Object` **`Schema`** CreateStockLocationInput title: "Create Stock Location Input" description: "Represents the Input to create a Stock Location" type: object required: - name properties: name: type: string description: The stock location name address_id: type: string description: The Stock location address ID address: description: Stock location address object allOf: - $ref: "#/components/schemas/StockLocationAddressInput" - type: object metadata: type: object description: An optional key-value map with additional details example: {car: "white"} #### Type declaration | Name | Type | | :------ | :------ | | `address?` | `string` \| [`StockLocationAddressInput`](internal-8.md#stocklocationaddressinput) | | `address_id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name` | `string` | #### Defined in packages/types/dist/stock-location/common.d.ts:229 ___ ### CreateTaxRateInput Ƭ **CreateTaxRateInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `code` | `string` | | `name` | `string` | | `rate?` | `number` \| ``null`` | | `region_id` | `string` | #### Defined in packages/medusa/dist/types/tax-rate.d.ts:17 ___ ### CustomerGroupConstructorProps Ƭ **CustomerGroupConstructorProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customerGroupRepository` | typeof [`CustomerGroupRepository`](internal-8.md#customergrouprepository) | | `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/customer-group.d.ts:8 ___ ### DefaultWithoutRelations Ƭ **DefaultWithoutRelations**: [`Omit`](internal-1.md#omit)<[`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)\>, ``"relations"``\> #### Defined in packages/medusa/dist/repositories/customer-group.d.ts:4 ___ ### DefaultWithoutRelations Ƭ **DefaultWithoutRelations**: [`Omit`](internal-1.md#omit)<[`ExtendedFindConfig`](internal-8.md#extendedfindconfig)<[`Product`](../classes/internal-3.Product.md)\>, ``"relations"``\> #### Defined in packages/medusa/dist/repositories/product.d.ts:4 ___ ### DeleteFileType Ƭ **DeleteFileType**: `Object` #### Index signature ▪ [x: `string`]: `unknown` #### Type declaration | Name | Type | | :------ | :------ | | `fileKey` | `string` | #### Defined in packages/types/dist/file-service/index.d.ts:19 ___ ### DeleteResponse Ƭ **DeleteResponse**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | | `id` | `string` | | `object` | `string` | #### Defined in packages/types/dist/common/common.d.ts:97 ___ ### Discount Ƭ **Discount**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `code` | `string` | #### Defined in packages/medusa/dist/types/draft-orders.d.ts:26 ___ ### DiscountAllocation Ƭ **DiscountAllocation**: `Object` The amount of a discount allocated to a line item #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `unit_amount` | `number` | #### Defined in packages/medusa/dist/types/totals.d.ts:18 ___ ### DiscountConditionInput Ƭ **DiscountConditionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customer_groups?` | (`string` \| { `id`: `string` })[] | | `id?` | `string` | | `operator?` | [`DiscountConditionOperator`](../enums/internal-3.DiscountConditionOperator.md) | | `product_collections?` | (`string` \| { `id`: `string` })[] | | `product_tags?` | (`string` \| { `id`: `string` })[] | | `product_types?` | (`string` \| { `id`: `string` })[] | | `products?` | (`string` \| { `id`: `string` })[] | | `rule_id?` | `string` | #### Defined in packages/medusa/dist/types/discount.d.ts:30 ___ ### DiscountConditionResourceType Ƭ **DiscountConditionResourceType**: `EntityTarget`<[`DiscountConditionProduct`](../classes/internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductType`](../classes/internal-8.internal.DiscountConditionProductType.md) \| [`DiscountConditionProductCollection`](../classes/internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](../classes/internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionCustomerGroup`](../classes/internal-8.internal.DiscountConditionCustomerGroup.md)\> #### Defined in packages/medusa/dist/repositories/discount-condition.d.ts:10 ___ ### DraftOrderCreateProps Ƭ **DraftOrderCreateProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `billing_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | | `billing_address_id?` | `string` | | `customer_id?` | `string` | | `discounts?` | [`Discount`](internal-8.md#discount)[] | | `email` | `string` | | `idempotency_key?` | `string` | | `items?` | [`Item`](internal-8.md#item)[] | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `no_notification_order?` | `boolean` | | `region_id` | `string` | | `shipping_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | | `shipping_address_id?` | `string` | | `shipping_methods` | [`ShippingMethod`](internal-8.md#shippingmethod)[] | | `status?` | `string` | #### Defined in packages/medusa/dist/types/draft-orders.d.ts:5 ___ ### EmitData Ƭ **EmitData**<`T`\>: `Object` #### Type parameters | Name | Type | | :------ | :------ | | `T` | `unknown` | #### Type declaration | Name | Type | | :------ | :------ | | `data` | `T` | | `eventName` | `string` | | `options?` | [`Record`](internal.md#record)<`string`, `unknown`\> | #### Defined in packages/types/dist/event-bus/common.d.ts:10 ___ ### ExtendedFindConfig Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](internal-1.md#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](internal-1.md#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } #### Type parameters | Name | | :------ | | `TEntity` | #### Defined in packages/types/dist/common/common.d.ts:50 ___ ### ExtendedStoreDTO Ƭ **ExtendedStoreDTO**: [`Store`](../classes/internal-8.internal.Store.md) & { `feature_flags`: [`FeatureFlagsResponse`](internal-8.md#featureflagsresponse) ; `fulfillment_providers`: [`FulfillmentProvider`](../classes/internal-3.FulfillmentProvider.md)[] ; `modules`: [`ModulesResponse`](internal-8.md#modulesresponse) ; `payment_providers`: [`PaymentProvider`](../classes/internal-3.PaymentProvider.md)[] } **`Schema`** ExtendedStoreDTO allOf: - $ref: "#/components/schemas/Store" - type: object required: - payment_providers - fulfillment_providers - feature_flags - modules properties: payment_providers: $ref: "#/components/schemas/PaymentProvider" fulfillment_providers: $ref: "#/components/schemas/FulfillmentProvider" feature_flags: $ref: "#/components/schemas/FeatureFlagsResponse" modules: $ref: "#/components/schemas/ModulesResponse" #### Defined in packages/medusa/dist/types/store.d.ts:52 ___ ### ExternalModuleDeclaration Ƭ **ExternalModuleDeclaration**: `Object` #### Type declaration | Name | Type | Description | | :------ | :------ | :------ | | `alias?` | `string` | If multiple modules are registered with the same key, the alias can be used to differentiate them | | `definition?` | [`ModuleDefinition`](internal-8.md#moduledefinition) | - | | `main?` | `boolean` | If the module is the main module for the key when multiple ones are registered | | `options?` | [`Record`](internal.md#record)<`string`, `unknown`\> | - | | `scope` | [`EXTERNAL`](internal-8.md#external) | - | | `server?` | { `keepAlive`: `boolean` ; `type`: ``"http"`` ; `url`: `string` } | - | | `server.keepAlive` | `boolean` | - | | `server.type` | ``"http"`` | - | | `server.url` | `string` | - | #### Defined in packages/types/dist/modules-sdk/index.d.ts:33 ___ ### FeatureFlagsResponse Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| [`Record`](internal.md#record)<`string`, `boolean`\> }[] **`Schema`** FeatureFlagsResponse type: array items: type: object required: - key - value properties: key: description: The key of the feature flag. type: string value: description: The value of the feature flag. type: boolean #### Defined in packages/medusa/dist/types/feature-flags.d.ts:21 ___ ### FeatureFlagsResponse Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| [`Record`](internal.md#record)<`string`, `boolean`\> }[] **`Schema`** FeatureFlagsResponse type: array items: type: object required: - key - value properties: key: description: The key of the feature flag. type: string value: description: The value of the feature flag. type: boolean #### Defined in packages/types/dist/feature-flag/common.d.ts:21 ___ ### FileServiceGetUploadStreamResult Ƭ **FileServiceGetUploadStreamResult**: `Object` #### Index signature ▪ [x: `string`]: `unknown` #### Type declaration | Name | Type | | :------ | :------ | | `fileKey` | `string` | | `promise` | `Promise`<`any`\> | | `url` | `string` | | `writeStream` | [`PassThrough`](../classes/internal-8.PassThrough.md) | #### Defined in packages/types/dist/file-service/index.d.ts:7 ___ ### FileServiceUploadResult Ƭ **FileServiceUploadResult**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `key` | `string` | | `url` | `string` | #### Defined in packages/types/dist/file-service/index.d.ts:3 ___ ### FilterableInventoryItemProps Ƭ **FilterableInventoryItemProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `hs_code?` | `string` \| `string`[] \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | | `id?` | `string` \| `string`[] | | `location_id?` | `string` \| `string`[] | | `origin_country?` | `string` \| `string`[] | | `q?` | `string` | | `requires_shipping?` | `boolean` | | `sku?` | `string` \| `string`[] \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | #### Defined in packages/types/dist/inventory/common.d.ts:204 ___ ### FilterableInventoryLevelProps Ƭ **FilterableInventoryLevelProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `incoming_quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | | `inventory_item_id?` | `string` \| `string`[] | | `location_id?` | `string` \| `string`[] | | `reserved_quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | | `stocked_quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | #### Defined in packages/types/dist/inventory/common.d.ts:239 ___ ### FilterableReservationItemProps Ƭ **FilterableReservationItemProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `created_by?` | `string` \| `string`[] | | `description?` | `string` \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | | `id?` | `string` \| `string`[] | | `inventory_item_id?` | `string` \| `string`[] | | `line_item_id?` | `string` \| `string`[] | | `location_id?` | `string` \| `string`[] | | `quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | | `type?` | `string` \| `string`[] | #### Defined in packages/types/dist/inventory/common.d.ts:194 ___ ### FilterableStockLocationProps Ƭ **FilterableStockLocationProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id?` | `string` \| `string`[] | | `name?` | `string` \| `string`[] \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | #### Defined in packages/types/dist/stock-location/common.d.ts:149 ___ ### FilterableTaxRateProps Ƭ **FilterableTaxRateProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `code?` | `string` \| `string`[] \| [`StringComparisonOperator`](../classes/internal-6.StringComparisonOperator.md) | | `created_at?` | `Date` \| [`DateComparisonOperator`](../classes/internal-2.DateComparisonOperator.md) | | `deleted_at?` | `Date` \| [`DateComparisonOperator`](../classes/internal-2.DateComparisonOperator.md) | | `name?` | `string` \| `string`[] | | `rate?` | `number` \| [`NumericalComparisonOperator`](../classes/internal-8.internal.NumericalComparisonOperator.md) | | `region_id?` | `string` \| `string`[] | | `updated_at?` | `Date` \| [`DateComparisonOperator`](../classes/internal-2.DateComparisonOperator.md) | #### Defined in packages/medusa/dist/types/tax-rate.d.ts:2 ___ ### FilterableUserProps Ƭ **FilterableUserProps**: [`PartialPick`](internal-8.internal.md#partialpick)<[`User`](../classes/internal-1.User.md), ``"email"`` \| ``"first_name"`` \| ``"last_name"`` \| ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\> #### Defined in packages/medusa/dist/types/user.d.ts:26 ___ ### FindProductConfig Ƭ **FindProductConfig**: [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Product`](../classes/internal-3.Product.md)\> & [`PriceListLoadConfig`](internal-8.internal.md#pricelistloadconfig) #### Defined in packages/medusa/dist/types/product.d.ts:146 ___ ### FindWithRelationsOptions Ƭ **FindWithRelationsOptions**: `FindManyOptions`<[`ProductVariant`](../classes/internal-3.ProductVariant.md)\> & { `order?`: `FindOptionsOrder`<[`ProductVariant`](../classes/internal-3.ProductVariant.md)\> ; `withDeleted?`: `boolean` } #### Defined in packages/medusa/dist/repositories/product-variant.d.ts:4 ___ ### FindWithoutRelationsOptions Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations) & { `where`: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations)[``"where"``] & { `discount_condition_id?`: `string` \| `FindOperator`<`string`\> } } #### Defined in packages/medusa/dist/repositories/customer-group.d.ts:5 ___ ### FindWithoutRelationsOptions Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations-1) & { `where`: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations-1)[``"where"``] & { `categories?`: `FindOptionsWhere`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> ; `category_id?`: [`CategoryQueryParams`](internal-8.md#categoryqueryparams) ; `discount_condition_id?`: `string` ; `include_category_children?`: `boolean` ; `price_list_id?`: `FindOperator`<[`PriceList`](../classes/internal-3.PriceList.md)\> ; `sales_channel_id?`: `FindOperator`<[`SalesChannel`](../classes/internal-3.SalesChannel.md)\> ; `tags?`: `FindOperator`<[`ProductTag`](../classes/internal-3.ProductTag.md)\> } } #### Defined in packages/medusa/dist/repositories/product.d.ts:8 ___ ### FulFillmentItemType Ƭ **FulFillmentItemType**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `item_id` | `string` | | `quantity` | `number` | #### Defined in packages/medusa/dist/types/fulfillment.d.ts:2 ___ ### FulfillmentItemPartition Ƭ **FulfillmentItemPartition**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `items` | [`LineItem`](../classes/internal-3.LineItem.md)[] | | `shipping_method` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md) | #### Defined in packages/medusa/dist/types/fulfillment.d.ts:6 ___ ### FulfillmentOptions Ƭ **FulfillmentOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `options` | [`Record`](internal.md#record)<`string`, `unknown`\>[] | | `provider_id` | `string` | #### Defined in packages/medusa/dist/types/fulfillment-provider.d.ts:2 ___ ### FulfillmentProviderContainer Ƭ **FulfillmentProviderContainer**: [`MedusaContainer`](internal-8.internal.md#medusacontainer) & { `fulfillmentProviderRepository`: typeof [`FulfillmentProviderRepository`](internal-8.md#fulfillmentproviderrepository) ; `manager`: `EntityManager` } & { [key in \`${FulfillmentProviderKey}\`]: typeof BaseFulfillmentService } #### Defined in packages/medusa/dist/services/fulfillment-provider.d.ts:10 ___ ### FulfillmentProviderData Ƭ **FulfillmentProviderData**: [`Record`](internal.md#record)<`string`, `unknown`\> #### Defined in packages/medusa/dist/interfaces/fulfillment-service.d.ts:4 ___ ### FulfillmentProviderKey Ƭ **FulfillmentProviderKey**: \`fp\_${string}\` #### Defined in packages/medusa/dist/services/fulfillment-provider.d.ts:9 ___ ### GenerateInputData Ƭ **GenerateInputData**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `quantity` | `number` | | `unit_price?` | `number` | | `variantId` | `string` | #### Defined in packages/medusa/dist/types/line-item.d.ts:2 ___ ### GenerateLineItemContext Ƭ **GenerateLineItemContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cart?` | [`CalculationContextData`](internal-8.md#calculationcontextdata) | | `customer_id?` | `string` | | `includes_tax?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `order_edit_id?` | `string` | | `region_id?` | `string` | | `unit_price?` | `number` | #### Defined in packages/medusa/dist/types/line-item.d.ts:8 ___ ### GeneratedAdjustment Ƭ **GeneratedAdjustment**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `description` | `string` | | `discount_id` | `string` | #### Defined in packages/medusa/dist/services/line-item-adjustment.d.ts:19 ___ ### GetLineItemTotalOptions Ƭ **GetLineItemTotalOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `exclude_discounts?` | `boolean` | | `include_tax?` | `boolean` | #### Defined in packages/medusa/dist/services/totals.d.ts:39 ___ ### GetRegionPriceContext Ƭ **GetRegionPriceContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customer_id?` | `string` | | `include_discount_prices?` | `boolean` | | `quantity?` | `number` | | `regionId` | `string` | #### Defined in packages/medusa/dist/types/product-variant.d.ts:11 ___ ### GetShippingMethodTotalsOptions Ƭ **GetShippingMethodTotalsOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `calculation_context?` | [`TaxCalculationContext`](internal-8.internal.md#taxcalculationcontext) | | `include_tax?` | `boolean` | | `use_tax_lines?` | `boolean` | #### Defined in packages/medusa/dist/services/totals.d.ts:16 ___ ### GetTotalsOptions Ƭ **GetTotalsOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `exclude_gift_cards?` | `boolean` | | `force_taxes?` | `boolean` | #### Defined in packages/medusa/dist/services/totals.d.ts:50 ___ ### GetUploadedFileType Ƭ **GetUploadedFileType**: `Object` #### Index signature ▪ [x: `string`]: `unknown` #### Type declaration | Name | Type | | :------ | :------ | | `fileKey` | `string` | | `isPrivate?` | `boolean` | #### Defined in packages/types/dist/file-service/index.d.ts:14 ___ ### GiftCardAllocation Ƭ **GiftCardAllocation**: `Object` The amount of a gift card allocated to a line item #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `unit_amount` | `number` | #### Defined in packages/medusa/dist/types/totals.d.ts:13 ___ ### GiftCardTransaction Ƭ **GiftCardTransaction**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `gift_card` | [`GiftCard`](../classes/internal-3.GiftCard.md) | | `is_taxable` | `boolean` \| ``null`` | | `tax_rate` | `number` \| ``null`` | #### Defined in packages/medusa/dist/services/new-totals.d.ts:19 ___ ### HttpCompressionOptions Ƭ **HttpCompressionOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `enabled?` | `boolean` | | `level?` | `number` | | `memLevel?` | `number` | | `threshold?` | `number` \| `string` | #### Defined in packages/types/dist/common/config-module.d.ts:12 ___ ### IdempotencyCallbackResult Ƭ **IdempotencyCallbackResult**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `recovery_point?` | `string` | | `response_body?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `response_code?` | `number` | #### Defined in packages/medusa/dist/types/idempotency-key.d.ts:7 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `analyticsConfigRepository` | typeof [`AnalyticsConfigRepository`](internal-8.md#analyticsconfigrepository) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/analytics-config.d.ts:7 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | | `manager` | `EntityManager` | | `userService` | [`UserService`](../classes/internal-8.internal.UserService.md) | #### Defined in packages/medusa/dist/services/auth.d.ts:6 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `batchJobRepository` | typeof [`BatchJobRepository`](internal-8.md#batchjobrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `strategyResolverService` | [`StrategyResolverService`](../classes/internal-8.internal.StrategyResolverService.md) | #### Defined in packages/medusa/dist/services/batch-job.d.ts:10 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | | `cartRepository` | typeof [`CartRepository`](internal-8.md#cartrepository) | | `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | | `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | | `discountService` | [`DiscountService`](../classes/internal-8.internal.DiscountService.md) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `giftCardService` | [`GiftCardService`](../classes/internal-8.internal.GiftCardService.md) | | `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | | `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | | `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | | `paymentSessionRepository` | typeof [`PaymentSessionRepository`](internal-8.md#paymentsessionrepository) | | `priceSelectionStrategy` | [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) | | `pricingService` | [`PricingService`](../classes/internal-8.internal.PricingService.md) | | `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | | `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | | `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | | `salesChannelService` | [`SalesChannelService`](../classes/internal-8.internal.SalesChannelService.md) | | `shippingMethodRepository` | typeof [`ShippingMethodRepository`](internal-8.md#shippingmethodrepository) | | `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | | `shippingProfileService` | [`ShippingProfileService`](../classes/internal-8.internal.ShippingProfileService.md) | | `storeService` | [`StoreService`](../classes/internal-8.internal.StoreService.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | | `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | #### Defined in packages/medusa/dist/services/cart.d.ts:13 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | | `claimItemService` | [`ClaimItemService`](../classes/internal-8.internal.ClaimItemService.md) | | `claimRepository` | typeof [`ClaimRepository`](internal-8.md#claimrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | | `fulfillmentService` | [`FulfillmentService`](../classes/internal-8.FulfillmentService.md) | | `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | | `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | | `returnService` | [`ReturnService`](../classes/internal-8.internal.ReturnService.md) | | `shippingMethodRepository` | typeof [`ShippingMethodRepository`](internal-8.md#shippingmethodrepository) | | `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | | `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | #### Defined in packages/medusa/dist/services/claim.d.ts:22 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `currencyRepository` | typeof [`CurrencyRepository`](internal-8.md#currencyrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/currency.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customShippingOptionRepository` | typeof [`CustomShippingOptionRepository`](internal-8.md#customshippingoptionrepository) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/custom-shipping-option.d.ts:7 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | | `customerRepository` | typeof [`CustomerRepository`](internal-8.md#customerrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/customer.d.ts:10 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `discountConditionRepository` | typeof [`DiscountConditionRepository`](internal-8.md#discountconditionrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/discount-condition.d.ts:8 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cartService` | [`CartService`](../classes/internal-8.internal.CartService.md) | | `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | | `draftOrderRepository` | typeof [`DraftOrderRepository`](internal-8.md#draftorderrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `orderRepository` | typeof [`OrderRepository`](internal-8.md#orderrepository) | | `paymentRepository` | typeof [`PaymentRepository`](internal-8.md#paymentrepository) | | `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | | `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | #### Defined in packages/medusa/dist/services/draft-order.d.ts:15 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusModuleService` | [`AbstractEventBusModuleService`](../classes/internal-8.AbstractEventBusModuleService.md) | | `logger` | [`Logger`](../interfaces/internal-8.Logger.md) | | `stagedJobService` | [`StagedJobService`](../classes/internal-8.internal.StagedJobService.md) | #### Defined in packages/medusa/dist/services/event-bus.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `giftCardRepository` | typeof [`GiftCardRepository`](internal-8.md#giftcardrepository) | | `giftCardTransactionRepository` | typeof [`GiftCardTransactionRepository`](internal-8.md#giftcardtransactionrepository) | | `manager` | `EntityManager` | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | #### Defined in packages/medusa/dist/services/gift-card.d.ts:10 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `idempotencyKeyRepository` | typeof [`IdempotencyKeyRepository`](internal-8.md#idempotencykeyrepository) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/idempotency-key.d.ts:7 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cartRepository` | typeof [`CartRepository`](internal-8.md#cartrepository) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | | `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | | `lineItemTaxLineRepository` | typeof [`LineItemTaxLineRepository`](internal-8.md#lineitemtaxlinerepository) | | `manager` | `EntityManager` | | `pricingService` | [`PricingService`](../classes/internal-8.internal.PricingService.md) | | `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | | `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | #### Defined in packages/medusa/dist/services/line-item.d.ts:14 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `manager` | `EntityManager` | | `taxCalculationStrategy` | [`ITaxCalculationStrategy`](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | #### Defined in packages/medusa/dist/services/new-totals.d.ts:34 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `noteRepository` | typeof [`NoteRepository`](internal-8.md#noterepository) | #### Defined in packages/medusa/dist/services/note.d.ts:8 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `logger` | [`Logger`](internal-8.internal.md#logger) | | `manager` | `EntityManager` | | `notificationProviderRepository` | typeof [`NotificationProviderRepository`](internal-8.md#notificationproviderrepository) | | `notificationRepository` | typeof [`NotificationRepository`](internal-8.md#notificationrepository) | #### Defined in packages/medusa/dist/services/notification.d.ts:8 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: [`MedusaContainer`](internal-8.internal.md#medusacontainer) & { `eventBusService`: [`EventBusService`](../classes/internal-8.internal.EventBusService.md) ; `manager`: `EntityManager` ; `oauthRepository`: typeof [`OauthRepository`](internal-8.md#oauthrepository) } #### Defined in packages/medusa/dist/services/oauth.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | | `cartService` | [`CartService`](../classes/internal-8.internal.CartService.md) | | `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | | `discountService` | [`DiscountService`](../classes/internal-8.internal.DiscountService.md) | | `draftOrderService` | [`DraftOrderService`](../classes/internal-8.internal.DraftOrderService.md) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | | `fulfillmentService` | [`FulfillmentService`](../classes/internal-8.FulfillmentService.md) | | `giftCardService` | [`GiftCardService`](../classes/internal-8.internal.GiftCardService.md) | | `inventoryService` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | | `orderRepository` | typeof [`OrderRepository`](internal-8.md#orderrepository) | | `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | | `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | | `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | | `shippingProfileService` | [`ShippingProfileService`](../classes/internal-8.internal.ShippingProfileService.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | | `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | #### Defined in packages/medusa/dist/services/order.d.ts:15 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `inventoryService?` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | | `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | | `orderEditItemChangeService` | [`OrderEditItemChangeService`](../classes/internal-8.internal.OrderEditItemChangeService.md) | | `orderEditRepository` | typeof [`OrderEditRepository`](internal-8.md#ordereditrepository) | | `orderService` | [`OrderService`](../classes/internal-8.internal.OrderService.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | | `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | #### Defined in packages/medusa/dist/services/order-edit.d.ts:10 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `orderItemChangeRepository` | typeof [`OrderItemChangeRepository`](internal-8.md#orderitemchangerepository) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | #### Defined in packages/medusa/dist/services/order-edit-item-change.d.ts:10 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `paymentCollectionRepository` | typeof [`PaymentCollectionRepository`](internal-8.md#paymentcollectionrepository) | | `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | #### Defined in packages/medusa/dist/services/payment-collection.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: { `customerService`: [`CustomerService`](../classes/internal-8.internal.CustomerService.md) ; `featureFlagRouter`: [`FlagRouter`](../classes/internal-8.FlagRouter.md) ; `logger`: [`Logger`](internal-8.internal.md#logger) ; `manager`: `EntityManager` ; `paymentProviderRepository`: typeof [`PaymentProviderRepository`](internal-8.md#paymentproviderrepository) ; `paymentRepository`: typeof [`PaymentRepository`](internal-8.md#paymentrepository) ; `paymentService`: [`PaymentService`](../classes/internal-8.PaymentService.md) ; `paymentSessionRepository`: typeof [`PaymentSessionRepository`](internal-8.md#paymentsessionrepository) ; `refundRepository`: typeof [`RefundRepository`](internal-8.md#refundrepository) } & { [key in \`${PaymentProviderKey}\`]: AbstractPaymentService \| typeof BasePaymentService } #### Defined in packages/medusa/dist/services/payment-provider.d.ts:16 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `manager` | `EntityManager` | | `priceSelectionStrategy` | [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) | | `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | #### Defined in packages/medusa/dist/services/pricing.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `imageRepository` | typeof [`ImageRepository`](internal-8.md#imagerepository) | | `manager` | `EntityManager` | | `productCategoryRepository` | typeof [`ProductCategoryRepository`](internal-8.md#productcategoryrepository) | | `productOptionRepository` | typeof [`ProductOptionRepository`](internal-8.md#productoptionrepository) | | `productRepository` | typeof [`ProductRepository`](internal-8.md#productrepository) | | `productTagRepository` | typeof [`ProductTagRepository`](internal-8.md#producttagrepository) | | `productTypeRepository` | typeof [`ProductTypeRepository`](internal-8.md#producttyperepository) | | `productVariantRepository` | typeof [`ProductVariantRepository`](internal-8.md#productvariantrepository) | | `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | | `searchService` | [`SearchService`](../classes/internal-8.internal.SearchService.md) | #### Defined in packages/medusa/dist/services/product.d.ts:16 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `productCategoryRepository` | typeof [`ProductCategoryRepository`](internal-8.md#productcategoryrepository) | #### Defined in packages/medusa/dist/services/product-category.d.ts:8 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `productCollectionRepository` | typeof [`ProductCollectionRepository`](internal-8.md#productcollectionrepository) | | `productRepository` | typeof [`ProductRepository`](internal-8.md#productrepository) | #### Defined in packages/medusa/dist/services/product-collection.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | | `inventoryService` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | | `manager` | `EntityManager` | | `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | | `salesChannelInventoryService` | [`SalesChannelInventoryService`](../classes/internal-8.internal.SalesChannelInventoryService.md) | | `salesChannelLocationService` | [`SalesChannelLocationService`](../classes/internal-8.internal.SalesChannelLocationService.md) | | `stockLocationService` | [`IStockLocationService`](../interfaces/internal-8.IStockLocationService.md) | #### Defined in packages/medusa/dist/services/product-variant-inventory.d.ts:10 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `countryRepository` | typeof [`CountryRepository`](internal-8.md#countryrepository) | | `currencyRepository` | typeof [`CurrencyRepository`](internal-8.md#currencyrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `fulfillmentProviderRepository` | typeof [`FulfillmentProviderRepository`](internal-8.md#fulfillmentproviderrepository) | | `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | | `manager` | `EntityManager` | | `paymentProviderRepository` | typeof [`PaymentProviderRepository`](internal-8.md#paymentproviderrepository) | | `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | | `regionRepository` | typeof [`RegionRepository`](internal-8.md#regionrepository) | | `storeService` | [`StoreService`](../classes/internal-8.internal.StoreService.md) | | `taxProviderRepository` | typeof [`TaxProviderRepository`](internal-8.md#taxproviderrepository) | #### Defined in packages/medusa/dist/services/region.d.ts:17 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `orderService` | [`OrderService`](../classes/internal-8.internal.OrderService.md) | | `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | | `returnItemRepository` | typeof [`ReturnItemRepository`](internal-8.md#returnitemrepository) | | `returnReasonService` | [`ReturnReasonService`](../classes/internal-8.internal.ReturnReasonService.md) | | `returnRepository` | typeof [`ReturnRepository`](internal-8.md#returnrepository) | | `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | | `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | #### Defined in packages/medusa/dist/services/return.d.ts:11 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `manager` | `EntityManager` | | `returnReasonRepository` | typeof [`ReturnReasonRepository`](internal-8.md#returnreasonrepository) | #### Defined in packages/medusa/dist/services/return-reason.d.ts:7 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `salesChannelRepository` | typeof [`SalesChannelRepository`](internal-8.md#saleschannelrepository) | | `storeService` | [`StoreService`](../classes/internal-8.internal.StoreService.md) | #### Defined in packages/medusa/dist/services/sales-channel.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | | `inventoryService` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | | `manager` | `EntityManager` | | `salesChannelLocationService` | [`SalesChannelLocationService`](../classes/internal-8.internal.SalesChannelLocationService.md) | #### Defined in packages/medusa/dist/services/sales-channel-inventory.d.ts:5 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | | `manager` | `EntityManager` | | `salesChannelService` | [`SalesChannelService`](../classes/internal-8.internal.SalesChannelService.md) | | `stockLocationService` | [`IStockLocationService`](../interfaces/internal-8.IStockLocationService.md) | #### Defined in packages/medusa/dist/services/sales-channel-location.d.ts:5 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `logger` | [`Logger`](internal-8.internal.md#logger) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/search.d.ts:4 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | | `manager` | `EntityManager` | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | | `shippingMethodRepository` | typeof [`ShippingMethodRepository`](internal-8.md#shippingmethodrepository) | | `shippingOptionRepository` | typeof [`ShippingOptionRepository`](internal-8.md#shippingoptionrepository) | | `shippingOptionRequirementRepository` | typeof [`ShippingOptionRequirementRepository`](internal-8.md#shippingoptionrequirementrepository) | #### Defined in packages/medusa/dist/services/shipping-option.d.ts:12 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `manager` | `EntityManager` | | `productRepository` | typeof [`ProductRepository`](internal-8.md#productrepository) | | `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | | `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | | `shippingProfileRepository` | typeof [`ShippingProfileRepository`](internal-8.md#shippingprofilerepository) | #### Defined in packages/medusa/dist/services/shipping-profile.d.ts:12 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `currencyRepository` | typeof [`CurrencyRepository`](internal-8.md#currencyrepository) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `storeRepository` | typeof [`StoreRepository`](internal-8.md#storerepository) | #### Defined in packages/medusa/dist/services/store.d.ts:9 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Index signature ▪ [key: `string`]: `unknown` #### Type declaration | Name | Type | | :------ | :------ | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/strategy-resolver.d.ts:3 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `configModule` | [`ConfigModule`](internal-8.internal.md#configmodule) | #### Defined in packages/medusa/dist/services/token.d.ts:4 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | | `fulfillmentRepository` | typeof [`FulfillmentRepository`](internal-8.md#fulfillmentrepository) | | `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | | `shippingProfileService` | [`ShippingProfileService`](../classes/internal-8.internal.ShippingProfileService.md) | | `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | | `trackingLinkRepository` | typeof [`TrackingLinkRepository`](internal-8.md#trackinglinkrepository) | #### Defined in packages/medusa/dist/services/fulfillment.d.ts:13 ___ ### InjectedDependencies Ƭ **InjectedDependencies**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `manager` | `EntityManager` | | `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | | `paymentRepository` | typeof [`PaymentRepository`](internal-8.md#paymentrepository) | #### Defined in packages/medusa/dist/services/payment.d.ts:8 ___ ### InjectedProps Ƭ **InjectedProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `cartService` | [`CartService`](../classes/internal-8.internal.CartService.md) | | `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `fulfillmentService` | [`FulfillmentService`](../classes/internal-8.FulfillmentService.md) | | `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | | `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | | `manager` | `EntityManager` | | `orderService` | [`OrderService`](../classes/internal-8.internal.OrderService.md) | | `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | | `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | | `returnService` | [`ReturnService`](../classes/internal-8.internal.ReturnService.md) | | `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | | `swapRepository` | typeof [`SwapRepository`](internal-8.md#swaprepository) | | `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | #### Defined in packages/medusa/dist/services/swap.d.ts:8 ___ ### InternalModuleDeclaration Ƭ **InternalModuleDeclaration**: `Object` #### Type declaration | Name | Type | Description | | :------ | :------ | :------ | | `alias?` | `string` | If multiple modules are registered with the same key, the alias can be used to differentiate them | | `definition?` | [`ModuleDefinition`](internal-8.md#moduledefinition) | - | | `dependencies?` | `string`[] | - | | `main?` | `boolean` | If the module is the main module for the key when multiple ones are registered | | `options?` | [`Record`](internal.md#record)<`string`, `unknown`\> | - | | `resolve?` | `string` | - | | `resources` | [`MODULE_RESOURCE_TYPE`](../enums/internal-8.MODULE_RESOURCE_TYPE.md) | - | | `scope` | [`INTERNAL`](internal-8.md#internal) | - | #### Defined in packages/types/dist/modules-sdk/index.d.ts:17 ___ ### InventoryItemDTO Ƭ **InventoryItemDTO**: `Object` **`Schema`** InventoryItemDTO type: object required: - sku properties: sku: description: The Stock Keeping Unit (SKU) code of the Inventory Item. type: string hs_code: description: The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string origin_country: description: The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string mid_code: description: The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string title: description: "Title of the inventory item" type: string description: description: "Description of the inventory item" type: string thumbnail: description: "Thumbnail for the inventory item" type: string material: description: The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. type: string weight: description: The weight of the Inventory Item. May be used in shipping rate calculations. type: number height: description: The height of the Inventory Item. May be used in shipping rate calculations. type: number width: description: The width of the Inventory Item. May be used in shipping rate calculations. type: number length: description: The length of the Inventory Item. May be used in shipping rate calculations. type: number requires_shipping: description: Whether the item requires shipping. type: boolean metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time #### Type declaration | Name | Type | | :------ | :------ | | `created_at` | `string` \| `Date` | | `deleted_at` | `string` \| `Date` \| ``null`` | | `description?` | `string` \| ``null`` | | `height?` | `number` \| ``null`` | | `hs_code?` | `string` \| ``null`` | | `id` | `string` | | `length?` | `number` \| ``null`` | | `material?` | `string` \| ``null`` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `mid_code?` | `string` \| ``null`` | | `origin_country?` | `string` \| ``null`` | | `requires_shipping` | `boolean` | | `sku?` | `string` \| ``null`` | | `thumbnail?` | `string` \| ``null`` | | `title?` | `string` \| ``null`` | | `updated_at` | `string` \| `Date` | | `weight?` | `number` \| ``null`` | | `width?` | `number` \| ``null`` | #### Defined in packages/types/dist/inventory/common.d.ts:64 ___ ### InventoryLevelDTO Ƭ **InventoryLevelDTO**: `Object` **`Schema`** InventoryLevelDTO type: object required: - inventory_item_id - location_id - stocked_quantity - reserved_quantity - incoming_quantity properties: location_id: description: the item location ID type: string stocked_quantity: description: the total stock quantity of an inventory item at the given location ID type: number reserved_quantity: description: the reserved stock quantity of an inventory item at the given location ID type: number incoming_quantity: description: the incoming stock quantity of an inventory item at the given location ID type: number metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time #### Type declaration | Name | Type | | :------ | :------ | | `created_at` | `string` \| `Date` | | `deleted_at` | `string` \| `Date` \| ``null`` | | `id` | `string` | | `incoming_quantity` | `number` | | `inventory_item_id` | `string` | | `location_id` | `string` | | `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `reserved_quantity` | `number` | | `stocked_quantity` | `number` | | `updated_at` | `string` \| `Date` | #### Defined in packages/types/dist/inventory/common.d.ts:182 ___ ### Item Ƭ **Item**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `quantity` | `number` | | `title?` | `string` | | `unit_price?` | `number` | | `variant_id?` | `string` | #### Defined in packages/medusa/dist/types/draft-orders.d.ts:29 ___ ### IteratorResult Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/internal-8.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/internal-8.IteratorReturnResult.md)<`TReturn`\> #### Type parameters | Name | Type | | :------ | :------ | | `T` | `T` | | `TReturn` | `any` | #### Defined in docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:39 ___ ### JoinerRelationship Ƭ **JoinerRelationship**: `Object` #### Type declaration | Name | Type | Description | | :------ | :------ | :------ | | `alias` | `string` | - | | `args?` | [`Record`](internal.md#record)<`string`, `any`\> | Extra arguments to pass to the remoteFetchData callback | | `foreignKey` | `string` | - | | `inverse?` | `boolean` | In an inverted relationship the foreign key is on the other service and the primary key is on the current service | | `isInternalService?` | `boolean` | If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more "internal" services | | `isList?` | `boolean` | Force the relationship to return a list | | `primaryKey` | `string` | - | | `serviceName` | `string` | - | #### Defined in packages/types/dist/joiner/index.d.ts:1 ___ ### LineAllocationsMap Ƭ **LineAllocationsMap**: `Object` A map of line item ids and its corresponding gift card and discount allocations #### Index signature ▪ [K: `string`]: { `discount?`: [`DiscountAllocation`](internal-8.md#discountallocation) ; `gift_card?`: [`GiftCardAllocation`](internal-8.md#giftcardallocation) } #### Defined in packages/medusa/dist/types/totals.d.ts:26 ___ ### LineDiscount Ƭ **LineDiscount**: `Object` Associates a line item and discount allocation. #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `lineItem` | [`LineItem`](../classes/internal-3.LineItem.md) | | `variant` | `string` | #### Defined in packages/medusa/dist/types/totals.d.ts:41 ___ ### LineDiscountAmount Ƭ **LineDiscountAmount**: `Object` Associates a line item and discount allocation. #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `customAdjustmentsAmount` | `number` | | `item` | [`LineItem`](../classes/internal-3.LineItem.md) | #### Defined in packages/medusa/dist/types/totals.d.ts:49 ___ ### LineItemAdjustmentServiceProps Ƭ **LineItemAdjustmentServiceProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `discountService` | [`DiscountService`](../classes/internal-8.internal.DiscountService.md) | | `lineItemAdjustmentRepository` | typeof [`LineItemAdjustmentRepository`](internal-8.md#lineitemadjustmentrepository) | | `manager` | `EntityManager` | #### Defined in packages/medusa/dist/services/line-item-adjustment.d.ts:9 ___ ### LineItemTotals Ƭ **LineItemTotals**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `discount_total` | `number` | | `original_tax_total` | `number` | | `original_total` | `number` | | `quantity` | `number` | | `raw_discount_total` | `number` | | `subtotal` | `number` | | `tax_lines` | [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[] | | `tax_total` | `number` | | `total` | `number` | | `unit_price` | `number` | #### Defined in packages/medusa/dist/services/new-totals.d.ts:7 ___ ### LineItemTotals Ƭ **LineItemTotals**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `discount_total` | `number` | | `original_tax_total` | `number` | | `original_total` | `number` | | `quantity` | `number` | | `raw_discount_total` | `number` | | `subtotal` | `number` | | `tax_lines` | [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[] | | `tax_total` | `number` | | `total` | `number` | | `unit_price` | `number` | #### Defined in packages/medusa/dist/services/totals.d.ts:21 ___ ### LineItemTotalsOptions Ƭ **LineItemTotalsOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `calculation_context?` | [`TaxCalculationContext`](internal-8.internal.md#taxcalculationcontext) | | `exclude_gift_cards?` | `boolean` | | `include_tax?` | `boolean` | | `use_tax_lines?` | `boolean` | #### Defined in packages/medusa/dist/services/totals.d.ts:33 ___ ### LineItemUpdate Ƭ **LineItemUpdate**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `quantity?` | `number` | | `region_id?` | `string` | | `should_calculate_prices?` | `boolean` | | `title?` | `string` | | `unit_price?` | `number` | | `variant_id?` | `string` | #### Defined in packages/medusa/dist/types/cart.d.ts:10 ___ ### LineItemValidateData Ƭ **LineItemValidateData**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `variant?` | { `product_id`: `string` } | | `variant.product_id` | `string` | | `variant_id` | `string` | #### Defined in packages/medusa/dist/types/cart.d.ts:19 ___ ### ListAndCountSelector Ƭ **ListAndCountSelector**: [`Selector`](internal-8.internal.md#selector)<[`ProductCollection`](../classes/internal-3.ProductCollection.md)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } #### Defined in packages/medusa/dist/services/product-collection.d.ts:15 ___ ### MedusaContainer Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](internal-8.md#medusacontainer) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-8.md#medusacontainer) } #### Defined in packages/types/dist/common/medusa-container.d.ts:2 ___ ### MedusaContainer Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](internal-8.md#medusacontainer-1) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-8.md#medusacontainer-1) } #### Defined in packages/medusa-core-utils/dist/medusa-container.d.ts:2 ___ ### ModuleDefinition Ƭ **ModuleDefinition**: `Object` #### Type declaration | Name | Type | Description | | :------ | :------ | :------ | | `canOverride?` | `boolean` | **`Deprecated`** property will be removed in future versions | | `defaultModuleDeclaration` | [`InternalModuleDeclaration`](internal-8.md#internalmoduledeclaration) \| [`ExternalModuleDeclaration`](internal-8.md#externalmoduledeclaration) | - | | `defaultPackage` | `string` \| ``false`` | - | | `dependencies?` | `string`[] | - | | `isLegacy?` | `boolean` | - | | `isQueryable?` | `boolean` | - | | `isRequired?` | `boolean` | **`Deprecated`** property will be removed in future versions | | `key` | `string` | - | | `label` | `string` | - | | `registrationName` | `string` | - | #### Defined in packages/types/dist/modules-sdk/index.d.ts:59 ___ ### ModuleJoinerConfig Ƭ **ModuleJoinerConfig**: [`Omit`](internal-1.md#omit)<[`JoinerServiceConfig`](../interfaces/internal-8.JoinerServiceConfig.md), ``"serviceName"`` \| ``"primaryKeys"`` \| ``"relationships"`` \| ``"extends"``\> & { `databaseConfig?`: { `extraFields?`: [`Record`](internal.md#record)<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `type`: ``"date"`` \| ``"time"`` \| ``"datetime"`` \| ``"bigint"`` \| ``"blob"`` \| ``"uint8array"`` \| ``"array"`` \| ``"enumArray"`` \| ``"enum"`` \| ``"json"`` \| ``"integer"`` \| ``"smallint"`` \| ``"tinyint"`` \| ``"mediumint"`` \| ``"float"`` \| ``"double"`` \| ``"boolean"`` \| ``"decimal"`` \| ``"string"`` \| ``"uuid"`` \| ``"text"`` }\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: [`Record`](internal.md#record)<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\> ; `relationship`: [`ModuleJoinerRelationship`](internal-8.md#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: [`Record`](internal.md#record)<`string`, `string`\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](internal-8.md#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` } #### Defined in packages/types/dist/modules-sdk/index.d.ts:104 ___ ### ModuleJoinerRelationship Ƭ **ModuleJoinerRelationship**: [`JoinerRelationship`](internal-8.md#joinerrelationship) & { `deleteCascade?`: `boolean` ; `isInternalService?`: `boolean` } #### Defined in packages/types/dist/modules-sdk/index.d.ts:152 ___ ### ModulesResponse Ƭ **ModulesResponse**: [`ModulesResponse`](internal-8.md#modulesresponse-1) **`Schema`** ModulesResponse type: array items: type: object required: - module - resolution properties: module: description: The key of the module. type: string resolution: description: The resolution path of the module or false if module is not installed. type: string #### Defined in packages/medusa/dist/types/store.d.ts:30 ___ ### ModulesResponse Ƭ **ModulesResponse**: { `module`: `string` ; `resolution`: `string` \| ``false`` }[] #### Defined in packages/types/dist/modules-sdk/index.d.ts:100 ___ ### OrdersReturnItem Ƭ **OrdersReturnItem**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `item_id` | `string` | | `note?` | `string` | | `quantity` | `number` | | `reason_id?` | `string` | #### Defined in packages/medusa/dist/types/return.d.ts:1 ___ ### PaginatedResponse Ƭ **PaginatedResponse**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `count` | `number` | | `limit` | `number` | | `offset` | `number` | #### Defined in packages/types/dist/common/common.d.ts:92 ___ ### Partial Ƭ **Partial**<`T`\>: { [P in keyof T]?: T[P] } Make all properties in T optional #### Type parameters | Name | | :------ | | `T` | #### Defined in docs-util/node_modules/typescript/lib/lib.es5.d.ts:1571 ___ ### PaymentCollectionsSessionsBatchInput Ƭ **PaymentCollectionsSessionsBatchInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `provider_id` | `string` | | `session_id?` | `string` | #### Defined in packages/medusa/dist/types/payment-collection.d.ts:11 ___ ### PaymentCollectionsSessionsInput Ƭ **PaymentCollectionsSessionsInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `provider_id` | `string` | #### Defined in packages/medusa/dist/types/payment-collection.d.ts:16 ___ ### PaymentDataInput Ƭ **PaymentDataInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `currency_code` | `string` | | `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `provider_id` | `string` | #### Defined in packages/medusa/dist/services/payment.d.ts:14 ___ ### PaymentProviderKey Ƭ **PaymentProviderKey**: \`pp\_${string}\` \| ``"systemPaymentProviderService"`` #### Defined in packages/medusa/dist/services/payment-provider.d.ts:15 ___ ### PaymentSessionInput Ƭ **PaymentSessionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `cart` | [`Cart`](../classes/internal-3.Cart.md) \| { `billing_address?`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `context`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `email`: `string` ; `id`: `string` ; `shipping_address`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `shipping_methods`: [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] } | | `currency_code` | `string` | | `customer?` | [`Customer`](../classes/internal-3.Customer.md) \| ``null`` | | `paymentSessionData?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `payment_session_id?` | `string` | | `provider_id` | `string` | | `resource_id?` | `string` | #### Defined in packages/medusa/dist/types/payment.d.ts:2 ___ ### Price Ƭ **Price**: [`Partial`](internal-8.md#partial)<[`Omit`](internal-1.md#omit)<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md), ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\>\> & { `amount`: `number` } #### Defined in packages/medusa/dist/repositories/money-amount.d.ts:5 ___ ### PriceListConstructorProps Ƭ **PriceListConstructorProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `customerGroupService` | [`CustomerGroupService`](../classes/internal-8.internal.CustomerGroupService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `manager` | `EntityManager` | | `moneyAmountRepository` | typeof [`MoneyAmountRepository`](internal-8.md#moneyamountrepository) | | `priceListRepository` | typeof [`PriceListRepository`](internal-8.md#pricelistrepository) | | `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | | `productVariantRepository` | typeof [`ProductVariantRepository`](internal-8.md#productvariantrepository) | | `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | | `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | #### Defined in packages/medusa/dist/services/price-list.d.ts:16 ___ ### PricedProduct Ƭ **PricedProduct**: [`Omit`](internal-1.md#omit)<[`Partial`](internal-8.md#partial)<[`Product`](../classes/internal-3.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-8.md#pricedvariant)[] } **`Schema`** PricedProduct title: "Priced Product" type: object allOf: - $ref: "#/components/schemas/Product" - type: object properties: variants: type: array items: $ref: "#/components/schemas/PricedVariant" #### Defined in packages/medusa/dist/types/pricing.d.ts:115 ___ ### PricedShippingOption Ƭ **PricedShippingOption**: [`Partial`](internal-8.md#partial)<[`ShippingOption`](../classes/internal-3.ShippingOption.md)\> & [`ShippingOptionPricing`](internal-8.md#shippingoptionpricing) **`Schema`** PricedShippingOption title: "Priced Shipping Option" type: object allOf: - $ref: "#/components/schemas/ShippingOption" - type: object properties: price_incl_tax: type: number description: Price including taxes tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate tax_amount: type: number description: The taxes applied. #### Defined in packages/medusa/dist/types/pricing.d.ts:58 ___ ### PricedVariant Ƭ **PricedVariant**: [`Partial`](internal-8.md#partial)<[`ProductVariant`](../classes/internal-3.ProductVariant.md)\> & [`ProductVariantPricing`](internal-8.md#productvariantpricing) **`Schema`** PricedVariant title: "Priced Product Variant" type: object allOf: - $ref: "#/components/schemas/ProductVariant" - type: object properties: original_price: type: number description: The original price of the variant without any discounted prices applied. calculated_price: type: number description: The calculated price of the variant. Can be a discounted price. original_price_incl_tax: type: number description: The original price of the variant including taxes. calculated_price_incl_tax: type: number description: The calculated price of the variant including taxes. original_tax: type: number description: The taxes applied on the original price. calculated_tax: type: number description: The taxes applied on the calculated price. tax_rates: type: array description: An array of applied tax rates items: type: object properties: rate: type: number description: The tax rate value name: type: string description: The name of the tax rate code: type: string description: The code of the tax rate #### Defined in packages/medusa/dist/types/pricing.d.ts:101 ___ ### PricingContext Ƭ **PricingContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `automatic_taxes` | `boolean` | | `price_selection` | [`PriceSelectionContext`](internal-8.internal.md#priceselectioncontext) | | `tax_rate` | `number` \| ``null`` | #### Defined in packages/medusa/dist/types/pricing.d.ts:19 ___ ### ProductCategoryInput Ƭ **ProductCategoryInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `handle?` | `string` | | `is_active?` | `boolean` | | `is_internal?` | `boolean` | | `parent_category?` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) \| ``null`` | | `parent_category_id?` | `string` \| ``null`` | | `rank?` | `number` | #### Defined in packages/medusa/dist/types/product-category.d.ts:3 ___ ### ProductOptionInput Ƭ **ProductOptionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `title` | `string` | | `values?` | [`ProductOptionValue`](../classes/internal-3.ProductOptionValue.md)[] | #### Defined in packages/medusa/dist/types/product.d.ts:142 ___ ### ProductSelector Ƭ **ProductSelector**: [`FilterableProductProps`](../classes/internal-8.FilterableProductProps.md) \| [`Selector`](internal-8.internal.md#selector)<[`Product`](../classes/internal-3.Product.md)\> & { `category_id?`: `string`[] \| `FindOperator`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> ; `discount_condition_id?`: `string` ; `price_list_id?`: `string`[] \| `FindOperator`<[`PriceList`](../classes/internal-3.PriceList.md)\> ; `q?`: `string` ; `sales_channel_id?`: `string`[] \| `FindOperator`<[`SalesChannel`](../classes/internal-3.SalesChannel.md)\> } #### Defined in packages/medusa/dist/types/product.d.ts:28 ___ ### ProductVariantOption Ƭ **ProductVariantOption**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `option_id` | `string` | | `value` | `string` | #### Defined in packages/medusa/dist/types/product-variant.d.ts:17 ___ ### ProductVariantPrice Ƭ **ProductVariantPrice**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `amount` | `number` | | `currency_code?` | `string` | | `id?` | `string` | | `max_quantity?` | `number` | | `min_quantity?` | `number` | | `region_id?` | `string` | #### Defined in packages/medusa/dist/types/product-variant.d.ts:3 ___ ### ProductVariantPricing Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[] } & [`TaxedPricing`](internal-8.md#taxedpricing) #### Defined in packages/medusa/dist/types/pricing.d.ts:4 ___ ### ProjectConfigOptions Ƭ **ProjectConfigOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `admin_cors?` | `string` | | `cookie_secret?` | `string` | | `database_database?` | `string` | | `database_extra?` | [`Record`](internal.md#record)<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } | | `database_logging` | `LoggerOptions` | | `database_schema?` | `string` | | `database_type?` | `string` | | `database_url?` | `string` | | `http_compression?` | [`HttpCompressionOptions`](internal-8.md#httpcompressionoptions) | | `jwt_secret?` | `string` | | `redis_options?` | `RedisOptions` | | `redis_prefix?` | `string` | | `redis_url?` | `string` | | `session_options?` | [`SessionOptions`](internal-8.md#sessionoptions) | | `store_cors?` | `string` | #### Defined in packages/types/dist/common/config-module.d.ts:18 ___ ### PropertyDecorator Ƭ **PropertyDecorator**: (`target`: [`Object`](internal-8.md#object), `propertyKey`: `string` \| `symbol`) => `void` #### Type declaration ▸ (`target`, `propertyKey`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `target` | [`Object`](internal-8.md#object) | | `propertyKey` | `string` \| `symbol` | ##### Returns `void` #### Defined in docs-util/node_modules/typescript/lib/lib.decorators.legacy.d.ts:20 ___ ### PropertyKey Ƭ **PropertyKey**: `string` \| `number` \| `symbol` #### Defined in docs-util/node_modules/typescript/lib/lib.es5.d.ts:108 ___ ### ProviderLineItemTaxLine Ƭ **ProviderLineItemTaxLine**: `Object` The tax line properties for a given line item. #### Type declaration | Name | Type | | :------ | :------ | | `code` | `string` \| ``null`` | | `item_id` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name` | `string` | | `rate` | `number` | #### Defined in packages/medusa/dist/types/tax-service.d.ts:33 ___ ### ProviderShippingMethodTaxLine Ƭ **ProviderShippingMethodTaxLine**: `Object` The tax line properties for a given shipping method. #### Type declaration | Name | Type | | :------ | :------ | | `code` | `string` \| ``null`` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name` | `string` | | `rate` | `number` | | `shipping_method_id` | `string` | #### Defined in packages/medusa/dist/types/tax-service.d.ts:23 ___ ### ProviderTaxLine Ƭ **ProviderTaxLine**: [`ProviderLineItemTaxLine`](internal-8.md#providerlineitemtaxline) \| [`ProviderShippingMethodTaxLine`](internal-8.md#providershippingmethodtaxline) A union type of the possible provider tax lines. #### Defined in packages/medusa/dist/types/tax-service.d.ts:43 ___ ### ReadableStreamController Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`T`\> #### Type parameters | Name | | :------ | | `T` | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:76 ___ ### ReadableStreamDefaultReadResult Ƭ **ReadableStreamDefaultReadResult**<`T`\>: [`ReadableStreamDefaultReadValueResult`](../interfaces/internal-8.ReadableStreamDefaultReadValueResult.md)<`T`\> \| [`ReadableStreamDefaultReadDoneResult`](../interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md) #### Type parameters | Name | | :------ | | `T` | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:77 ___ ### RegionDetails Ƭ **RegionDetails**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id` | `string` | | `tax_rate` | `number` \| ``null`` | #### Defined in packages/medusa/dist/services/tax-provider.d.ts:10 ___ ### ReorderConditions Ƭ **ReorderConditions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `originalParentId` | `string` \| ``null`` | | `originalRank` | `number` | | `shouldChangeParent` | `boolean` | | `shouldChangeRank` | `boolean` | | `shouldDeleteElement` | `boolean` | | `shouldIncrementRank` | `boolean` | | `targetCategoryId` | `string` | | `targetParentId` | `string` \| ``null`` \| `undefined` | | `targetRank` | `number` \| `undefined` | #### Defined in packages/medusa/dist/types/product-category.d.ts:27 ___ ### RequestContext Ƭ **RequestContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `ip` | `string` | #### Defined in packages/medusa/dist/types/request.d.ts:1 ___ ### ReservationItemDTO Ƭ **ReservationItemDTO**: `Object` **`Schema`** ReservationItemDTO title: "Reservation item" description: "Represents a reservation of an inventory item at a stock location" type: object required: - id - location_id - inventory_item_id - quantity properties: id: description: "The id of the reservation item" type: string location_id: description: "The id of the location of the reservation" type: string inventory_item_id: description: "The id of the inventory item the reservation relates to" type: string description: description: "Description of the reservation item" type: string created_by: description: "UserId of user who created the reservation item" type: string quantity: description: "The id of the reservation item" type: number metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time #### Type declaration | Name | Type | | :------ | :------ | | `created_at` | `string` \| `Date` | | `created_by?` | `string` \| ``null`` | | `deleted_at` | `string` \| `Date` \| ``null`` | | `description?` | `string` \| ``null`` | | `id` | `string` | | `inventory_item_id` | `string` | | `line_item_id?` | `string` \| ``null`` | | `location_id` | `string` | | `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `quantity` | `number` | | `updated_at` | `string` \| `Date` | #### Defined in packages/types/dist/inventory/common.d.ts:130 ___ ### ReserveQuantityContext Ƭ **ReserveQuantityContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `lineItemId?` | `string` | | `locationId?` | `string` | | `salesChannelId?` | `string` \| ``null`` | #### Defined in packages/types/dist/inventory/common.d.ts:267 ___ ### ReturnedData Ƭ **ReturnedData**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `status` | `string` | | `to` | `string` | #### Defined in packages/medusa/dist/interfaces/notification-service.d.ts:2 ___ ### SessionOptions Ƭ **SessionOptions**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `name?` | `string` | | `resave?` | `boolean` | | `rolling?` | `boolean` | | `saveUninitialized?` | `boolean` | | `secret?` | `string` | | `ttl?` | `number` | #### Defined in packages/types/dist/common/config-module.d.ts:4 ___ ### SharedContext Ƭ **SharedContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `manager?` | `EntityManager` | | `transactionManager?` | `EntityManager` | #### Defined in packages/types/dist/shared-context.d.ts:2 ___ ### ShippingMethod Ƭ **ShippingMethod**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `option_id` | `string` | | `price?` | `number` | #### Defined in packages/medusa/dist/types/draft-orders.d.ts:21 ___ ### ShippingMethodData Ƭ **ShippingMethodData**: [`Record`](internal.md#record)<`string`, `unknown`\> #### Defined in packages/medusa/dist/interfaces/fulfillment-service.d.ts:6 ___ ### ShippingMethodTotals Ƭ **ShippingMethodTotals**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `original_tax_total` | `number` | | `original_total` | `number` | | `price` | `number` | | `subtotal` | `number` | | `tax_lines` | [`ShippingMethodTaxLine`](../classes/internal-3.ShippingMethodTaxLine.md)[] | | `tax_total` | `number` | | `total` | `number` | #### Defined in packages/medusa/dist/services/new-totals.d.ts:25 ___ ### ShippingMethodTotals Ƭ **ShippingMethodTotals**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `original_tax_total` | `number` | | `original_total` | `number` | | `price` | `number` | | `subtotal` | `number` | | `tax_lines` | [`ShippingMethodTaxLine`](../classes/internal-3.ShippingMethodTaxLine.md)[] | | `tax_total` | `number` | | `total` | `number` | #### Defined in packages/medusa/dist/services/totals.d.ts:7 ___ ### ShippingMethodUpdate Ƭ **ShippingMethodUpdate**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `claim_order_id?` | `string` \| ``null`` | | `data?` | `any` | | `order_id?` | `string` | | `price?` | `number` | | `return_id?` | `string` | | `swap_id?` | `string` | #### Defined in packages/medusa/dist/types/shipping-options.d.ts:9 ___ ### ShippingOptionData Ƭ **ShippingOptionData**: [`Record`](internal.md#record)<`string`, `unknown`\> #### Defined in packages/medusa/dist/interfaces/fulfillment-service.d.ts:5 ___ ### ShippingOptionPricing Ƭ **ShippingOptionPricing**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `price_incl_tax` | `number` \| ``null`` | | `tax_amount` | `number` | | `tax_rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] \| ``null`` | #### Defined in packages/medusa/dist/types/pricing.d.ts:24 ___ ### StagedJobServiceProps Ƭ **StagedJobServiceProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `manager` | `EntityManager` | | `stagedJobRepository` | typeof [`StagedJobRepository`](internal-8.md#stagedjobrepository) | #### Defined in packages/medusa/dist/services/staged-job.d.ts:7 ___ ### StockLocationAddressDTO Ƭ **StockLocationAddressDTO**: `Object` **`Schema`** StockLocationAddressDTO title: "Stock Location Address" description: "Represents a Stock Location Address" type: object required: - address_1 - country_code - created_at - updated_at properties: id: type: string description: The stock location address' ID example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 address_1: type: string description: Stock location address example: 35, Jhon Doe Ave address_2: type: string description: Stock location address' complement example: apartment 4432 company: type: string description: Stock location company' name example: Medusa city: type: string description: Stock location address' city example: Mexico city country_code: type: string description: Stock location address' country example: MX phone: type: string description: Stock location address' phone number example: +1 555 61646 postal_code: type: string description: Stock location address' postal code example: HD3-1G8 province: type: string description: Stock location address' province example: Sinaloa created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time metadata: type: object description: An optional key-value map with additional details example: {car: "white"} #### Type declaration | Name | Type | | :------ | :------ | | `address_1` | `string` | | `address_2?` | `string` \| ``null`` | | `city?` | `string` \| ``null`` | | `company?` | `string` \| ``null`` | | `country_code` | `string` | | `created_at` | `string` \| `Date` | | `deleted_at` | `string` \| `Date` \| ``null`` | | `id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `phone?` | `string` \| ``null`` | | `postal_code?` | `string` \| ``null`` | | `province?` | `string` \| ``null`` | | `updated_at` | `string` \| `Date` | #### Defined in packages/types/dist/stock-location/common.d.ts:66 ___ ### StockLocationAddressInput Ƭ **StockLocationAddressInput**: `Object` **`Schema`** StockLocationAddressInput title: "Stock Location Address Input" description: "Represents a Stock Location Address Input" type: object required: - address_1 - country_code properties: address_1: type: string description: Stock location address example: 35, Jhon Doe Ave address_2: type: string description: Stock location address' complement example: apartment 4432 city: type: string description: Stock location address' city example: Mexico city country_code: type: string description: Stock location address' country example: MX phone: type: string description: Stock location address' phone number example: +1 555 61646 postal_code: type: string description: Stock location address' postal code example: HD3-1G8 province: type: string description: Stock location address' province example: Sinaloa metadata: type: object description: An optional key-value map with additional details example: {car: "white"} #### Type declaration | Name | Type | | :------ | :------ | | `address_1` | `string` | | `address_2?` | `string` | | `city?` | `string` | | `country_code` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `phone?` | `string` | | `postal_code?` | `string` | | `province?` | `string` | #### Defined in packages/types/dist/stock-location/common.d.ts:195 ___ ### StockLocationDTO Ƭ **StockLocationDTO**: `Object` **`Schema`** StockLocationDTO title: "Stock Location" description: "Represents a Stock Location" type: object required: - id - name - address_id - created_at - updated_at properties: id: type: string description: The stock location's ID example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 address_id: type: string description: Stock location address' ID example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 name: type: string description: The name of the stock location example: Main Warehouse address: description: "The Address of the Stock Location" allOf: - $ref: "#/components/schemas/StockLocationAddressDTO" - type: object metadata: type: object description: An optional key-value map with additional details example: {car: "white"} created_at: type: string description: "The date with timezone at which the resource was created." format: date-time updated_at: type: string description: "The date with timezone at which the resource was updated." format: date-time deleted_at: type: string description: "The date with timezone at which the resource was deleted." format: date-time #### Type declaration | Name | Type | | :------ | :------ | | `address?` | [`StockLocationAddressDTO`](internal-8.md#stocklocationaddressdto) | | `address_id` | `string` | | `created_at` | `string` \| `Date` | | `deleted_at` | `string` \| `Date` \| ``null`` | | `id` | `string` | | `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `name` | `string` | | `updated_at` | `string` \| `Date` | #### Defined in packages/types/dist/stock-location/common.d.ts:127 ___ ### StockLocationExpandedDTO Ƭ **StockLocationExpandedDTO**: [`StockLocationDTO`](internal-8.md#stocklocationdto) & { `sales_channels?`: `any`[] } **`Schema`** StockLocationExpandedDTO allOf: - $ref: "#/components/schemas/StockLocationDTO" - type: object properties: sales_channels: $ref: "#/components/schemas/SalesChannel" #### Defined in packages/types/dist/stock-location/common.d.ts:146 ___ ### Subscriber Ƭ **Subscriber**<`T`\>: (`data`: `T`, `eventName`: `string`) => `Promise`<`void`\> #### Type parameters | Name | Type | | :------ | :------ | | `T` | `unknown` | #### Type declaration ▸ (`data`, `eventName`): `Promise`<`void`\> ##### Parameters | Name | Type | | :------ | :------ | | `data` | `T` | | `eventName` | `string` | ##### Returns `Promise`<`void`\> #### Defined in packages/types/dist/event-bus/common.d.ts:1 ___ ### SubscriberContext Ƭ **SubscriberContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `subscriberId` | `string` | #### Defined in packages/types/dist/event-bus/common.d.ts:2 ___ ### SubscriberDescriptor Ƭ **SubscriberDescriptor**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id` | `string` | | `subscriber` | [`Subscriber`](internal-8.md#subscriber) | #### Defined in packages/types/dist/event-bus/common.d.ts:5 ___ ### SubtotalOptions Ƭ **SubtotalOptions**: `Object` Options to use for subtotal calculations #### Type declaration | Name | Type | | :------ | :------ | | `excludeNonDiscounts?` | `boolean` | #### Defined in packages/medusa/dist/types/totals.d.ts:35 ___ ### TaxLinesMaps Ƭ **TaxLinesMaps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `lineItemsTaxLines` | { `[lineItemId: string]`: [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[]; } | | `shippingMethodsTaxLines` | { `[shippingMethodId: string]`: [`ShippingMethodTaxLine`](../classes/internal-3.ShippingMethodTaxLine.md)[]; } | #### Defined in packages/medusa/dist/types/tax-service.d.ts:2 ___ ### TaxRateListByConfig Ƭ **TaxRateListByConfig**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `region_id?` | `string` | #### Defined in packages/medusa/dist/types/tax-rate.d.ts:23 ___ ### TaxServiceRate Ƭ **TaxServiceRate**: `Object` The tax rate object as configured in Medusa. These may have an unspecified numerical rate as they may be used for lookup purposes in the tax provider plugin. #### Type declaration | Name | Type | | :------ | :------ | | `code` | `string` \| ``null`` | | `name` | `string` | | `rate?` | `number` \| ``null`` | #### Defined in packages/medusa/dist/types/tax-service.d.ts:15 ___ ### TaxedPricing Ƭ **TaxedPricing**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `calculated_price_incl_tax` | `number` \| ``null`` | | `calculated_tax` | `number` \| ``null`` | | `original_price_incl_tax` | `number` \| ``null`` | | `original_tax` | `number` \| ``null`` | | `tax_rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] \| ``null`` | #### Defined in packages/medusa/dist/types/pricing.d.ts:12 ___ ### TotalsConfig Ƭ **TotalsConfig**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `force_taxes?` | `boolean` | #### Defined in packages/medusa/dist/services/cart.d.ts:43 ___ ### TotalsContext Ƭ **TotalsContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `force_taxes?` | `boolean` | | `includes?` | { `returnable_items?`: `boolean` } | | `includes.returnable_items?` | `boolean` | #### Defined in packages/medusa/dist/types/orders.d.ts:4 ___ ### TotalsServiceProps Ƭ **TotalsServiceProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `manager` | `EntityManager` | | `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | | `taxCalculationStrategy` | [`ITaxCalculationStrategy`](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) | | `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | #### Defined in packages/medusa/dist/services/totals.d.ts:43 ___ ### TransformCallback Ƭ **TransformCallback**: (`error?`: [`Error`](internal-8.md#error) \| ``null``, `data?`: `any`) => `void` #### Type declaration ▸ (`error?`, `data?`): `void` ##### Parameters | Name | Type | | :------ | :------ | | `error?` | [`Error`](internal-8.md#error) \| ``null`` | | `data?` | `any` | ##### Returns `void` #### Defined in packages/medusa-js/node_modules/@types/node/stream.d.ts:1044 ___ ### Transformer Ƭ **Transformer**: (`item?`: [`LineItem`](../classes/internal-3.LineItem.md), `quantity?`: `number`, `additional?`: [`OrdersReturnItem`](../classes/internal-8.OrdersReturnItem.md)) => `Promise`<`DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\>\> \| `DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\> #### Type declaration ▸ (`item?`, `quantity?`, `additional?`): `Promise`<`DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\>\> \| `DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\> ##### Parameters | Name | Type | | :------ | :------ | | `item?` | [`LineItem`](../classes/internal-3.LineItem.md) | | `quantity?` | `number` | | `additional?` | [`OrdersReturnItem`](../classes/internal-8.OrdersReturnItem.md) | ##### Returns `Promise`<`DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\>\> \| `DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\> #### Defined in packages/medusa/dist/services/return.d.ts:25 ___ ### TypedArray Ƭ **TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array` #### Defined in packages/medusa-js/node_modules/@types/node/globals.d.ts:239 ___ ### UpdateAnalyticsConfig Ƭ **UpdateAnalyticsConfig**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `anonymize?` | `boolean` | | `opt_out?` | `boolean` | #### Defined in packages/medusa/dist/types/analytics-config.d.ts:5 ___ ### UpdateClaimInput Ƭ **UpdateClaimInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `claim_items?` | [`UpdateClaimItemInput`](internal-8.md#updateclaimiteminput)[] | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `no_notification?` | `boolean` | | `shipping_methods?` | [`UpdateClaimShippingMethodInput`](internal-8.md#updateclaimshippingmethodinput)[] | #### Defined in packages/medusa/dist/types/claim.d.ts:42 ___ ### UpdateClaimItemImageInput Ƭ **UpdateClaimItemImageInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id?` | `string` | | `url?` | `string` | #### Defined in packages/medusa/dist/types/claim.d.ts:62 ___ ### UpdateClaimItemInput Ƭ **UpdateClaimItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id` | `string` | | `images` | [`UpdateClaimItemImageInput`](internal-8.md#updateclaimitemimageinput)[] | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `note?` | `string` | | `reason?` | `string` | | `tags` | [`UpdateClaimItemTagInput`](internal-8.md#updateclaimitemtaginput)[] | #### Defined in packages/medusa/dist/types/claim.d.ts:54 ___ ### UpdateClaimItemTagInput Ƭ **UpdateClaimItemTagInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `id?` | `string` | | `value?` | `string` | #### Defined in packages/medusa/dist/types/claim.d.ts:66 ___ ### UpdateClaimShippingMethodInput Ƭ **UpdateClaimShippingMethodInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `id?` | `string` | | `option_id?` | `string` | | `price?` | `number` | #### Defined in packages/medusa/dist/types/claim.d.ts:48 ___ ### UpdateCurrencyInput Ƭ **UpdateCurrencyInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `includes_tax?` | `boolean` | #### Defined in packages/medusa/dist/types/currency.d.ts:1 ___ ### UpdateCustomerInput Ƭ **UpdateCustomerInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `billing_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) \| `string` | | `billing_address_id?` | `string` | | `email?` | `string` | | `first_name?` | `string` | | `groups?` | { `id`: `string` }[] | | `last_name?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `password?` | `string` | | `phone?` | `string` | #### Defined in packages/medusa/dist/types/customers.d.ts:17 ___ ### UpdateDiscountInput Ƭ **UpdateDiscountInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `code?` | `string` | | `ends_at?` | `Date` \| ``null`` | | `is_disabled?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `regions?` | `string`[] | | `rule?` | [`UpdateDiscountRuleInput`](internal-8.md#updatediscountruleinput) | | `starts_at?` | `Date` | | `usage_limit?` | `number` \| ``null`` | | `valid_duration?` | `string` \| ``null`` | #### Defined in packages/medusa/dist/types/discount.d.ts:76 ___ ### UpdateDiscountRuleInput Ƭ **UpdateDiscountRuleInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `allocation?` | [`AllocationType`](../enums/internal-3.AllocationType.md) | | `conditions?` | [`DiscountConditionInput`](internal-8.md#discountconditioninput)[] | | `description?` | `string` | | `id` | `string` | | `value?` | `number` | #### Defined in packages/medusa/dist/types/discount.d.ts:69 ___ ### UpdateGiftCardInput Ƭ **UpdateGiftCardInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `balance?` | `number` | | `ends_at?` | `Date` \| ``null`` | | `is_disabled?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `region_id?` | `string` | #### Defined in packages/medusa/dist/types/gift-card.d.ts:11 ___ ### UpdateInventoryLevelInput Ƭ **UpdateInventoryLevelInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `incoming_quantity?` | `number` | | `stocked_quantity?` | `number` | #### Defined in packages/types/dist/inventory/common.d.ts:253 ___ ### UpdateOauthInput Ƭ **UpdateOauthInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | #### Defined in packages/medusa/dist/types/oauth.d.ts:7 ___ ### UpdateOrderInput Ƭ **UpdateOrderInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `billing_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) | | `customer_id?` | `string` | | `discounts?` | `object`[] | | `email?` | `string` | | `fulfillment_status?` | [`FulfillmentStatus`](../enums/internal-8.FulfillmentStatus.md) | | `items?` | `object`[] | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `no_notification?` | `boolean` | | `payment?` | [`Payment`](../classes/internal-3.Payment.md) | | `payment_method?` | { `data?`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `provider_id?`: `string` } | | `payment_method.data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `payment_method.provider_id?` | `string` | | `payment_status?` | [`PaymentStatus`](../enums/internal-8.PaymentStatus.md) | | `region?` | `string` | | `shipping_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) | | `shipping_method?` | { `data?`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `items?`: [`Record`](internal.md#record)<`string`, `unknown`\>[] ; `price?`: `number` ; `profile_id?`: `string` ; `provider_id?`: `string` }[] | | `status?` | [`OrderStatus`](../enums/internal-8.OrderStatus.md) | #### Defined in packages/medusa/dist/types/orders.d.ts:59 ___ ### UpdateProductCategoryInput Ƭ **UpdateProductCategoryInput**: [`ProductCategoryInput`](internal-8.md#productcategoryinput) & { `name?`: `string` } #### Defined in packages/medusa/dist/types/product-category.d.ts:14 ___ ### UpdateProductCollection Ƭ **UpdateProductCollection**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `handle?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `title?` | `string` | #### Defined in packages/medusa/dist/types/product-collection.d.ts:6 ___ ### UpdateProductInput Ƭ **UpdateProductInput**: [`Omit`](internal-1.md#omit)<[`Partial`](internal-8.md#partial)<[`CreateProductInput`](internal-8.md#createproductinput)\>, ``"variants"``\> & { `variants?`: [`UpdateProductProductVariantDTO`](internal-8.md#updateproductproductvariantdto)[] } #### Defined in packages/medusa/dist/types/product.d.ts:139 ___ ### UpdateProductProductVariantDTO Ƭ **UpdateProductProductVariantDTO**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `allow_backorder?` | `boolean` | | `barcode?` | `string` | | `ean?` | `string` | | `height?` | `number` | | `hs_code?` | `string` | | `id?` | `string` | | `inventory_quantity?` | `number` | | `length?` | `number` | | `manage_inventory?` | `boolean` | | `material?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `mid_code?` | `string` | | `options?` | { `option_id`: `string` ; `value`: `string` }[] | | `origin_country?` | `string` | | `prices?` | [`CreateProductProductVariantPriceInput`](internal-8.md#createproductproductvariantpriceinput)[] | | `sku?` | `string` | | `title?` | `string` | | `upc?` | `string` | | `weight?` | `number` | | `width?` | `number` | #### Defined in packages/medusa/dist/types/product.d.ts:104 ___ ### UpdateProductVariantData Ƭ **UpdateProductVariantData**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `updateData` | [`UpdateProductVariantInput`](internal-8.md#updateproductvariantinput) | | `variant` | [`ProductVariant`](../classes/internal-3.ProductVariant.md) | #### Defined in packages/medusa/dist/types/product-variant.d.ts:67 ___ ### UpdateProductVariantInput Ƭ **UpdateProductVariantInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `allow_backorder?` | `boolean` | | `barcode?` | `string` | | `ean?` | `string` | | `height?` | `number` | | `hs_code?` | `string` | | `inventory_quantity?` | `number` | | `length?` | `number` | | `manage_inventory?` | `boolean` | | `material?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `mid_code?` | `string` | | `options?` | [`ProductVariantOption`](internal-8.md#productvariantoption)[] | | `origin_country?` | `string` | | `prices?` | [`ProductVariantPrice`](internal-8.md#productvariantprice)[] | | `product_id?` | `string` | | `sku?` | `string` | | `title?` | `string` | | `upc?` | `string` | | `variant_rank?` | `number` | | `weight?` | `number` | | `width?` | `number` | #### Defined in packages/medusa/dist/types/product-variant.d.ts:44 ___ ### UpdateRegionInput Ƭ **UpdateRegionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `automatic_taxes?` | `boolean` | | `countries?` | `string`[] | | `currency_code?` | `string` | | `fulfillment_providers?` | `string`[] | | `gift_cards_taxable?` | `boolean` | | `includes_tax?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name?` | `string` | | `payment_providers?` | `string`[] | | `tax_code?` | `string` | | `tax_provider_id?` | `string` \| ``null`` | | `tax_rate?` | `number` | #### Defined in packages/medusa/dist/types/region.d.ts:1 ___ ### UpdateReservationItemInput Ƭ **UpdateReservationItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `description?` | `string` | | `location_id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | | `quantity?` | `number` | #### Defined in packages/types/dist/inventory/common.d.ts:261 ___ ### UpdateReturnInput Ƭ **UpdateReturnInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `items?` | [`OrdersReturnItem`](internal-8.md#ordersreturnitem)[] | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `no_notification?` | `boolean` | | `shipping_method?` | { `option_id`: `string` ; `price?`: `number` } | | `shipping_method.option_id` | `string` | | `shipping_method.price?` | `number` | #### Defined in packages/medusa/dist/types/return.d.ts:21 ___ ### UpdateReturnReason Ƭ **UpdateReturnReason**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `description?` | `string` | | `label?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `parent_return_reason_id?` | `string` | #### Defined in packages/medusa/dist/types/return-reason.d.ts:8 ___ ### UpdateShippingOptionInput Ƭ **UpdateShippingOptionInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `admin_only?` | `boolean` | | `amount?` | `number` | | `data?` | `string` | | `includes_tax?` | `boolean` | | `is_return?` | `boolean` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name?` | `string` | | `price_type?` | [`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md) | | `profile_id?` | `string` | | `provider_id?` | `string` | | `region_id?` | `string` | | `requirements?` | [`ShippingOptionRequirement`](../classes/internal-3.ShippingOptionRequirement.md)[] | #### Defined in packages/medusa/dist/types/shipping-options.d.ts:52 ___ ### UpdateShippingProfile Ƭ **UpdateShippingProfile**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name?` | `string` | | `products?` | `string`[] | | `shipping_options?` | `string`[] | | `type?` | [`ShippingProfileType`](../enums/internal-3.ShippingProfileType.md) | #### Defined in packages/medusa/dist/types/shipping-profile.d.ts:7 ___ ### UpdateStockLocationInput Ƭ **UpdateStockLocationInput**: `Object` **`Schema`** UpdateStockLocationInput title: "Update Stock Location Input" description: "Represents the Input to update a Stock Location" type: object properties: name: type: string description: The stock location name address_id: type: string description: The Stock location address ID address: description: Stock location address object allOf: - $ref: "#/components/schemas/StockLocationAddressInput" - type: object metadata: type: object description: An optional key-value map with additional details example: {car: "white"} #### Type declaration | Name | Type | | :------ | :------ | | `address?` | [`StockLocationAddressInput`](internal-8.md#stocklocationaddressinput) | | `address_id?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name?` | `string` | #### Defined in packages/types/dist/stock-location/common.d.ts:257 ___ ### UpdateStoreInput Ƭ **UpdateStoreInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `currencies?` | `string`[] | | `default_currency_code?` | `string` | | `default_sales_channel_id?` | `string` | | `invite_link_template?` | `string` | | `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | | `name?` | `string` | | `payment_link_template?` | `string` | | `swap_link_template?` | `string` | #### Defined in packages/medusa/dist/types/store.d.ts:4 ___ ### UpdateTaxRateInput Ƭ **UpdateTaxRateInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `code?` | `string` | | `name?` | `string` | | `rate?` | `number` \| ``null`` | | `region_id?` | `string` | #### Defined in packages/medusa/dist/types/tax-rate.d.ts:11 ___ ### UpdateVariantPricesData Ƭ **UpdateVariantPricesData**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `prices` | [`ProductVariantPrice`](internal-8.md#productvariantprice)[] | | `variantId` | `string` | #### Defined in packages/medusa/dist/types/product-variant.d.ts:71 ___ ### UpdateVariantRegionPriceData Ƭ **UpdateVariantRegionPriceData**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `price` | { `amount`: `number` ; `currency_code`: `string` ; `region_id`: `string` } | | `price.amount` | `number` | | `price.currency_code` | `string` | | `price.region_id` | `string` | | `variantId` | `string` | #### Defined in packages/medusa/dist/types/product-variant.d.ts:75 ___ ### UploadStreamDescriptorType Ƭ **UploadStreamDescriptorType**: `Object` #### Index signature ▪ [x: `string`]: `unknown` #### Type declaration | Name | Type | | :------ | :------ | | `ext?` | `string` | | `isPrivate?` | `boolean` | | `name` | `string` | #### Defined in packages/types/dist/file-service/index.d.ts:23 ___ ### UpsertTagsInput Ƭ **UpsertTagsInput**: [`Partial`](internal-8.md#partial)<[`ProductTag`](../classes/internal-3.ProductTag.md)\> & { `value`: `string` }[] #### Defined in packages/medusa/dist/repositories/product-tag.d.ts:4 ___ ### UpsertTypeInput Ƭ **UpsertTypeInput**: [`Partial`](internal-8.md#partial)<[`ProductType`](../classes/internal-3.ProductType.md)\> & { `value`: `string` } #### Defined in packages/medusa/dist/repositories/product-type.d.ts:3 ___ ### UserServiceProps Ƭ **UserServiceProps**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `analyticsConfigService` | [`AnalyticsConfigService`](../classes/internal-8.internal.AnalyticsConfigService.md) | | `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | | `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | | `manager` | `EntityManager` | | `userRepository` | typeof [`UserRepository`](internal-8.md#userrepository) | #### Defined in packages/medusa/dist/services/user.d.ts:10 ___ ### WithImplicitCoercion Ƭ **WithImplicitCoercion**<`T`\>: `T` \| { `valueOf`: () => `T` } #### Type parameters | Name | | :------ | | `T` | #### Defined in packages/medusa-js/node_modules/@types/node/buffer.d.ts:235 ___ ### handler Ƭ **handler**: (`req`: `Request`, `res`: `Response`) => `Promise`<`void`\> #### Type declaration ▸ (`req`, `res`): `Promise`<`void`\> ##### Parameters | Name | Type | | :------ | :------ | | `req` | `Request` | | `res` | `Response` | ##### Returns `Promise`<`void`\> #### Defined in packages/medusa/dist/api/middlewares/await-middleware.d.ts:2 ___ ### middlewareHandlerType Ƭ **middlewareHandlerType**: (`options`: [`Record`](internal.md#record)<`string`, `unknown`\>) => `RequestHandler` #### Type declaration ▸ (`options`): `RequestHandler` ##### Parameters | Name | Type | | :------ | :------ | | `options` | [`Record`](internal.md#record)<`string`, `unknown`\> | ##### Returns `RequestHandler` #### Defined in packages/medusa/dist/services/middleware.d.ts:2 ___ ### middlewareType Ƭ **middlewareType**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `middleware` | [`middlewareHandlerType`](internal-8.md#middlewarehandlertype) | | `options` | [`Record`](internal.md#record)<`string`, `unknown`\> | #### Defined in packages/medusa/dist/services/middleware.d.ts:3 ## Variables ### AddressRepository • `Const` **AddressRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/address.d.ts:2 ___ ### AdminGetDiscountsParams\_base • `Const` **AdminGetDiscountsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:77 ___ ### AdminGetInventoryItemsParams\_base • `Const` **AdminGetInventoryItemsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:94 ___ ### AdminGetPriceListsPriceListProductsParams\_base • `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:165 ___ ### AdminGetProductCategoriesParams\_base • `Const` **AdminGetProductCategoriesParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:67 ___ ### AdminGetReservationsParams\_base • `Const` **AdminGetReservationsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:146 ___ ### AdminGetSalesChannelsParams\_base • `Const` **AdminGetSalesChannelsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:132 ___ ### AdminGetStockLocationsParams\_base • `Const` **AdminGetStockLocationsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts:129 ___ ### AnalyticsConfigRepository • `Const` **AnalyticsConfigRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/analytics-config.d.ts:2 ___ ### BatchJobRepository • `Const` **BatchJobRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/batch-job.d.ts:2 ___ ### Buffer • **Buffer**: [`BufferConstructor`](../interfaces/internal-8.BufferConstructor.md) #### Defined in packages/medusa-js/node_modules/@types/node/buffer.d.ts:622 packages/medusa-js/node_modules/@types/node/buffer.d.ts:2305 ___ ### CartRepository • `Const` **CartRepository**: `Repository` & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](../classes/internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Cart`](../classes/internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](../classes/internal-3.Cart.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](../classes/internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Cart`](../classes/internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](../classes/internal-3.Cart.md)[]\> } #### Defined in packages/medusa/dist/repositories/cart.d.ts:3 ___ ### ClaimRepository • `Const` **ClaimRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/claim.d.ts:2 ___ ### CountryRepository • `Const` **CountryRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/country.d.ts:2 ___ ### CurrencyRepository • `Const` **CurrencyRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/currency.d.ts:2 ___ ### CustomShippingOptionRepository • `Const` **CustomShippingOptionRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/custom-shipping-option.d.ts:2 ___ ### CustomerGroupRepository • `Const` **CustomerGroupRepository**: `Repository` & { `addCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)\> ; `findWithRelationsAndCount`: (`relations?`: `FindOptionsRelations`<[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)\>, `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions)) => `Promise`<[[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)[], `number`]\> ; `removeCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<`DeleteResult`\> } #### Defined in packages/medusa/dist/repositories/customer-group.d.ts:10 ___ ### CustomerRepository • `Const` **CustomerRepository**: `Repository` & { `listAndCount`: (`query`: `Object`, `q?`: `string`) => `Promise`<[[`Customer`](../classes/internal-3.Customer.md)[], `number`]\> } #### Defined in packages/medusa/dist/repositories/customer.d.ts:4 ___ ### DiscountConditionRepository • `Const` **DiscountConditionRepository**: `Repository` & { `addConditionResources`: (`conditionId`: `string`, `resourceIds`: (`string` \| { `id`: `string` })[], `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `overrideExisting?`: `boolean`) => `Promise`<([`DiscountConditionCustomerGroup`](../classes/internal-8.internal.DiscountConditionCustomerGroup.md) \| [`DiscountConditionProduct`](../classes/internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductCollection`](../classes/internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](../classes/internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionProductType`](../classes/internal-8.internal.DiscountConditionProductType.md))[]\> ; `canApplyForCustomer`: (`discountRuleId`: `string`, `customerId`: `string`) => `Promise`<`boolean`\> ; `findOneWithDiscount`: (`conditionId`: `string`, `discountId`: `string`) => `Promise`<`undefined` \| [`DiscountCondition`](../classes/internal-3.DiscountCondition.md) & { `discount`: [`Discount`](../classes/internal-3.Discount.md) }\> ; `getJoinTableResourceIdentifiers`: (`type`: `string`) => { `conditionTable`: [`DiscountConditionResourceType`](internal-8.md#discountconditionresourcetype) ; `joinTable`: `string` ; `joinTableForeignKey`: [`DiscountConditionJoinTableForeignKey`](../enums/internal-8.DiscountConditionJoinTableForeignKey.md) ; `joinTableKey`: `string` ; `relatedTable`: `string` ; `resourceKey`: `string` } ; `isValidForProduct`: (`discountRuleId`: `string`, `productId`: `string`) => `Promise`<`boolean`\> ; `queryConditionTable`: (`__namedParameters`: { `conditionId`: `any` ; `resourceId`: `any` ; `type`: `any` }) => `Promise`<`number`\> ; `removeConditionResources`: (`id`: `string`, `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `resourceIds`: (`string` \| { `id`: `string` })[]) => `Promise`<`void` \| `DeleteResult`\> } #### Defined in packages/medusa/dist/repositories/discount-condition.d.ts:11 ___ ### DraftOrderRepository • `Const` **DraftOrderRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/draft-order.d.ts:2 ___ ### FulfillmentProviderRepository • `Const` **FulfillmentProviderRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/fulfillment-provider.d.ts:2 ___ ### FulfillmentRepository • `Const` **FulfillmentRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/fulfillment.d.ts:2 ___ ### GetOrderEditsParams\_base • `Const` **GetOrderEditsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:62 ___ ### GetPublishableApiKeySalesChannelsParams\_base • `Const` **GetPublishableApiKeySalesChannelsParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.d.ts:58 ___ ### GetPublishableApiKeysParams\_base • `Const` **GetPublishableApiKeysParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:61 ___ ### GiftCardRepository • `Const` **GiftCardRepository**: `Repository` & { `listGiftCardsAndCount`: (`query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`GiftCard`](../classes/internal-3.GiftCard.md)\>, `q?`: `string`) => `Promise`<[[`GiftCard`](../classes/internal-3.GiftCard.md)[], `number`]\> } #### Defined in packages/medusa/dist/repositories/gift-card.d.ts:3 ___ ### GiftCardTransactionRepository • `Const` **GiftCardTransactionRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/gift-card-transaction.d.ts:2 ___ ### IdempotencyKeyRepository • `Const` **IdempotencyKeyRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/idempotency-key.d.ts:2 ___ ### ImageRepository • `Const` **ImageRepository**: `Repository` & { `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`Image`](../classes/internal-3.Image.md)\>[]) => `Promise`<[`Image`](../classes/internal-3.Image.md)[]\> ; `upsertImages`: (`imageUrls`: `string`[]) => `Promise`<[`Image`](../classes/internal-3.Image.md)[]\> } #### Defined in packages/medusa/dist/repositories/image.d.ts:3 ___ ### LineItemAdjustmentRepository • `Const` **LineItemAdjustmentRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/line-item-adjustment.d.ts:2 ___ ### LineItemRepository • `Const` **LineItemRepository**: `Repository` & { `findByReturn`: (`returnId`: `string`) => `Promise`<[`LineItem`](../classes/internal-3.LineItem.md) & { `return_item`: [`ReturnItem`](../classes/internal-3.ReturnItem.md) }[]\> } #### Defined in packages/medusa/dist/repositories/line-item.d.ts:3 ___ ### LineItemTaxLineRepository • `Const` **LineItemTaxLineRepository**: `Repository` & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[]) => `Promise`<[`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[]\> } #### Defined in packages/medusa/dist/repositories/line-item-tax-line.d.ts:2 ___ ### MoneyAmountRepository • `Const` **MoneyAmountRepository**: `Repository` & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: [`PriceListPriceCreateInput`](internal-8.internal.md#pricelistpricecreateinput)[], `overrideExisting?`: `boolean`) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `createProductVariantMoneyAmounts`: (`toCreate`: { `money_amount_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<`InsertResult`\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: [`ProductVariantPrice`](internal-8.md#productvariantprice)[] ; `variantId`: `string` }[], `prices?`: [`Price`](internal-8.md#price)[]) => `Promise`<`void`\> ; `findCurrencyMoneyAmounts`: (`where`: { `currency_code`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`internal`](internal-8.internal-1.md) ; `currency_code`: `string` ; `deleted_at`: `Date` \| ``null`` ; `id`: `string` ; `max_quantity`: `number` \| ``null`` ; `min_quantity`: `number` \| ``null`` ; `price_list`: [`internal`](internal-8.internal-1.md) \| ``null`` ; `price_list_id`: `string` \| ``null`` ; `region?`: [`internal`](internal-8.internal-1.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](../classes/internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] }[]\> ; `findManyForVariantInPriceList`: (`variant_id`: `string`, `price_list_id`: `string`, `requiresPriceList?`: `boolean`) => `Promise`<[[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantInRegion`: (`variant_id`: `string`, `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`Record`](internal.md#record)<`string`, [`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\>, `number`]\> ; `findRegionMoneyAmounts`: (`where`: { `region_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`internal`](internal-8.internal-1.md) ; `currency_code`: `string` ; `deleted_at`: `Date` \| ``null`` ; `id`: `string` ; `max_quantity`: `number` \| ``null`` ; `min_quantity`: `number` \| ``null`` ; `price_list`: [`internal`](internal-8.internal-1.md) \| ``null`` ; `price_list_id`: `string` \| ``null`` ; `region?`: [`internal`](internal-8.internal-1.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](../classes/internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] }[]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: [`Price`](internal-8.md#price)[]) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `getPricesForVariantInRegion`: (`variantId`: `string`, `regionId`: `undefined` \| `string`) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)\>[]) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `updatePriceListPrices`: (`priceListId`: `string`, `updates`: [`PriceListPriceUpdateInput`](internal-8.internal.md#pricelistpriceupdateinput)[]) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `upsertVariantCurrencyPrice`: (`variantId`: `string`, `price`: [`Price`](internal-8.md#price)) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)\> } #### Defined in packages/medusa/dist/repositories/money-amount.d.ts:8 ___ ### NoteRepository • `Const` **NoteRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/note.d.ts:2 ___ ### NotificationProviderRepository • `Const` **NotificationProviderRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/notification-provider.d.ts:2 ___ ### NotificationRepository • `Const` **NotificationRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/notification.d.ts:2 ___ ### OauthRepository • `Const` **OauthRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/oauth.d.ts:2 ___ ### OrderEditRepository • `Const` **OrderEditRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/order-edit.d.ts:2 ___ ### OrderItemChangeRepository • `Const` **OrderItemChangeRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/order-item-change.d.ts:2 ___ ### OrderRepository • `Const` **OrderRepository**: `Repository` & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](../classes/internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Order`](../classes/internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](../classes/internal-3.Order.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](../classes/internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Order`](../classes/internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](../classes/internal-3.Order.md)[]\> } #### Defined in packages/medusa/dist/repositories/order.d.ts:3 ___ ### PaymentCollectionRepository • `Const` **PaymentCollectionRepository**: `Repository` & { `getPaymentCollectionIdByPaymentId`: (`paymentId`: `string`, `config?`: `FindManyOptions`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\>) => `Promise`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\> ; `getPaymentCollectionIdBySessionId`: (`sessionId`: `string`, `config?`: `FindManyOptions`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\>) => `Promise`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\> } #### Defined in packages/medusa/dist/repositories/payment-collection.d.ts:3 ___ ### PaymentProviderRepository • `Const` **PaymentProviderRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/payment-provider.d.ts:2 ___ ### PaymentRepository • `Const` **PaymentRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/payment.d.ts:2 ___ ### PaymentSessionRepository • `Const` **PaymentSessionRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/payment-session.d.ts:2 ___ ### PriceListRepository • `Const` **PriceListRepository**: `Repository` & { `listAndCount`: (`query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`PriceList`](../classes/internal-3.PriceList.md)\>, `q?`: `string`) => `Promise`<[[`PriceList`](../classes/internal-3.PriceList.md)[], `number`]\> ; `listPriceListsVariantIdsMap`: (`priceListIds`: `string` \| `string`[]) => `Promise`<{ `[priceListId: string]`: `string`[]; }\> } #### Defined in packages/medusa/dist/repositories/price-list.d.ts:3 ___ ### ProductCategoryRepository • `Const` **ProductCategoryRepository**: `TreeRepository` & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>, `treeScope?`: [`QuerySelector`](internal-8.internal.md#queryselector)<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>) => `Promise`<``null`` \| [`ProductCategory`](../classes/internal-3.ProductCategory.md)\> ; `getFreeTextSearchResultsAndCount`: (`options?`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>, `q?`: `string`, `treeScope?`: [`QuerySelector`](internal-8.internal.md#queryselector)<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>, `includeTree?`: `boolean`) => `Promise`<[[`ProductCategory`](../classes/internal-3.ProductCategory.md)[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } #### Defined in packages/medusa/dist/repositories/product-category.d.ts:4 ___ ### ProductCollectionRepository • `Const` **ProductCollectionRepository**: `Repository` & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductCollection`](../classes/internal-3.ProductCollection.md)\>) => `Promise`<[[`ProductCollection`](../classes/internal-3.ProductCollection.md)[], `number`]\> } #### Defined in packages/medusa/dist/repositories/product-collection.d.ts:3 ___ ### ProductOptionRepository • `Const` **ProductOptionRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/product-option.d.ts:2 ___ ### ProductRepository • `Const` **ProductRepository**: `Repository` & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<[`Product`](../classes/internal-3.Product.md)\>, `__namedParameters`: { `alias`: `any` ; `categoryAlias`: `any` ; `joinName`: `any` ; `where`: `any` }) => `SelectQueryBuilder`<[`Product`](../classes/internal-3.Product.md)\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1) ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> ; `findOneWithRelations`: (`relations?`: `string`[], `optionsWithoutRelations?`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[`Product`](../classes/internal-3.Product.md)\> ; `findWithRelations`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1), `withDeleted?`: `boolean`) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> ; `findWithRelationsAndCount`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: [`CategoryQueryParams`](internal-8.md#categoryqueryparams), `includeCategoryChildren?`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: [`ProductCategory`](../classes/internal-3.ProductCategory.md)) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1), `relations?`: `string`[]) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1), `shouldCount?`: `boolean`) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof [`Product`](../classes/internal-3.Product.md)[] ; `where?`: `FindOptionsWhere`<[`Product`](../classes/internal-3.Product.md)\> ; `withDeleted?`: `boolean` }) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> } #### Defined in packages/medusa/dist/repositories/product.d.ts:19 ___ ### ProductTagRepository • `Const` **ProductTagRepository**: `Repository` & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductTag`](../classes/internal-3.ProductTag.md)\>) => `Promise`<[[`ProductTag`](../classes/internal-3.ProductTag.md)[], `number`]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`ProductTag`](../classes/internal-3.ProductTag.md)\>[]) => `Promise`<[`ProductTag`](../classes/internal-3.ProductTag.md)[]\> ; `listTagsByUsage`: (`take?`: `number`) => `Promise`<[`ProductTag`](../classes/internal-3.ProductTag.md)[]\> ; `upsertTags`: (`tags`: [`UpsertTagsInput`](internal-8.md#upserttagsinput)) => `Promise`<[`ProductTag`](../classes/internal-3.ProductTag.md)[]\> } #### Defined in packages/medusa/dist/repositories/product-tag.d.ts:13 ___ ### ProductTypeRepository • `Const` **ProductTypeRepository**: `Repository` & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductType`](../classes/internal-3.ProductType.md)\>) => `Promise`<[[`ProductType`](../classes/internal-3.ProductType.md)[], `number`]\> ; `upsertType`: (`type?`: [`UpsertTypeInput`](internal-8.md#upserttypeinput)) => `Promise`<``null`` \| [`ProductType`](../classes/internal-3.ProductType.md)\> } #### Defined in packages/medusa/dist/repositories/product-type.d.ts:6 ___ ### ProductVariantRepository • `Const` **ProductVariantRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/product-variant.d.ts:8 ___ ### ReadableByteStreamController • **ReadableByteStreamController**: `Object` #### Call signature • **new ReadableByteStreamController**(): [`ReadableByteStreamController`](internal-8.md#readablebytestreamcontroller) ##### Returns [`ReadableByteStreamController`](internal-8.md#readablebytestreamcontroller) #### Type declaration | Name | Type | | :------ | :------ | | `prototype` | [`ReadableByteStreamController`](internal-8.md#readablebytestreamcontroller) | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:160 packages/medusa-js/node_modules/@types/node/stream/web.d.ts:167 ___ ### ReadableStream • **ReadableStream**: `Object` #### Call signature • **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](internal-8.md#readablestream)<`Uint8Array`\> ##### Parameters | Name | Type | | :------ | :------ | | `underlyingSource` | [`UnderlyingByteSource`](../interfaces/internal-8.UnderlyingByteSource.md) | | `strategy?` | [`QueuingStrategy`](../interfaces/internal-8.QueuingStrategy.md)<`Uint8Array`\> | ##### Returns [`ReadableStream`](internal-8.md#readablestream)<`Uint8Array`\> • **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](internal-8.md#readablestream)<`R`\> ##### Type parameters | Name | Type | | :------ | :------ | | `R` | `any` | ##### Parameters | Name | Type | | :------ | :------ | | `underlyingSource?` | [`UnderlyingSource`](../interfaces/internal-8.UnderlyingSource.md)<`R`\> | | `strategy?` | [`QueuingStrategy`](../interfaces/internal-8.QueuingStrategy.md)<`R`\> | ##### Returns [`ReadableStream`](internal-8.md#readablestream)<`R`\> #### Type declaration | Name | Type | | :------ | :------ | | `prototype` | [`ReadableStream`](internal-8.md#readablestream)<`any`\> | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:135 packages/medusa-js/node_modules/@types/node/stream/web.d.ts:145 ___ ### ReadableStreamDefaultController • **ReadableStreamDefaultController**: `Object` #### Call signature • **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`any`\> ##### Returns [`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`any`\> #### Type declaration | Name | Type | | :------ | :------ | | `prototype` | [`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`any`\> | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:171 packages/medusa-js/node_modules/@types/node/stream/web.d.ts:177 ___ ### ReadableStreamDefaultReader • **ReadableStreamDefaultReader**: `Object` #### Call signature • **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](internal-8.md#readablestreamdefaultreader)<`R`\> ##### Type parameters | Name | Type | | :------ | :------ | | `R` | `any` | ##### Parameters | Name | Type | | :------ | :------ | | `stream` | [`ReadableStream`](internal-8.md#readablestream)<`R`\> | ##### Returns [`ReadableStreamDefaultReader`](internal-8.md#readablestreamdefaultreader)<`R`\> #### Type declaration | Name | Type | | :------ | :------ | | `prototype` | [`ReadableStreamDefaultReader`](internal-8.md#readablestreamdefaultreader)<`any`\> | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:150 packages/medusa-js/node_modules/@types/node/stream/web.d.ts:154 ___ ### RefundRepository • `Const` **RefundRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/refund.d.ts:2 ___ ### RegionRepository • `Const` **RegionRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/region.d.ts:2 ___ ### ReturnItemRepository • `Const` **ReturnItemRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/return-item.d.ts:2 ___ ### ReturnReasonRepository • `Const` **ReturnReasonRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/return-reason.d.ts:2 ___ ### ReturnRepository • `Const` **ReturnRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/return.d.ts:2 ___ ### SalesChannelRepository • `Const` **SalesChannelRepository**: `Repository` & { `addProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`SalesChannel`](../classes/internal-3.SalesChannel.md)\>) => `Promise`<[[`SalesChannel`](../classes/internal-3.SalesChannel.md)[], `number`]\> ; `listProductIdsBySalesChannelIds`: (`salesChannelIds`: `string` \| `string`[]) => `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } #### Defined in packages/medusa/dist/repositories/sales-channel.d.ts:4 ___ ### SharedArrayBuffer • **SharedArrayBuffer**: [`SharedArrayBufferConstructor`](../interfaces/internal-8.SharedArrayBufferConstructor.md) #### Defined in docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:22 docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:40 ___ ### ShippingMethodRepository • `Const` **ShippingMethodRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/shipping-method.d.ts:2 ___ ### ShippingOptionRepository • `Const` **ShippingOptionRepository**: `Repository` & { `upsertShippingProfile`: (`shippingOptionIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<[`ShippingOption`](../classes/internal-3.ShippingOption.md)[]\> } #### Defined in packages/medusa/dist/repositories/shipping-option.d.ts:2 ___ ### ShippingOptionRequirementRepository • `Const` **ShippingOptionRequirementRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/shipping-option-requirement.d.ts:2 ___ ### ShippingProfileRepository • `Const` **ShippingProfileRepository**: `Repository` & { `findByProducts`: (`productIds`: `string` \| `string`[]) => `Promise`<{ `[product_id: string]`: [`ShippingProfile`](../classes/internal-3.ShippingProfile.md)[]; }\> } #### Defined in packages/medusa/dist/repositories/shipping-profile.d.ts:2 ___ ### StagedJobRepository • `Const` **StagedJobRepository**: `Repository` & { `insertBulk`: (`jobToCreates`: `_QueryDeepPartialEntity`<[`StagedJob`](../classes/internal-8.internal.StagedJob.md)\>[]) => `Promise`<[`StagedJob`](../classes/internal-8.internal.StagedJob.md)[]\> } #### Defined in packages/medusa/dist/repositories/staged-job.d.ts:3 ___ ### StoreGetProductCategoriesParams\_base • `Const` **StoreGetProductCategoriesParams\_base**: [`internal`](internal-8.internal.md) #### Defined in packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts:67 ___ ### StoreRepository • `Const` **StoreRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/store.d.ts:2 ___ ### SwapRepository • `Const` **SwapRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/swap.d.ts:2 ___ ### TaxProviderRepository • `Const` **TaxProviderRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/tax-provider.d.ts:2 ___ ### TrackingLinkRepository • `Const` **TrackingLinkRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/tracking-link.d.ts:2 ___ ### UserRepository • `Const` **UserRepository**: `Repository` #### Defined in packages/medusa/dist/repositories/user.d.ts:2 ___ ### WritableStream • **WritableStream**: `Object` #### Call signature • **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](internal-8.md#writablestream)<`W`\> ##### Type parameters | Name | Type | | :------ | :------ | | `W` | `any` | ##### Parameters | Name | Type | | :------ | :------ | | `underlyingSink?` | [`UnderlyingSink`](../interfaces/internal-8.UnderlyingSink.md)<`W`\> | | `strategy?` | [`QueuingStrategy`](../interfaces/internal-8.QueuingStrategy.md)<`W`\> | ##### Returns [`WritableStream`](internal-8.md#writablestream)<`W`\> #### Type declaration | Name | Type | | :------ | :------ | | `prototype` | [`WritableStream`](internal-8.md#writablestream)<`any`\> | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:211 packages/medusa-js/node_modules/@types/node/stream/web.d.ts:217 ___ ### WritableStreamDefaultController • **WritableStreamDefaultController**: `Object` #### Call signature • **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](internal-8.md#writablestreamdefaultcontroller) ##### Returns [`WritableStreamDefaultController`](internal-8.md#writablestreamdefaultcontroller) #### Type declaration | Name | Type | | :------ | :------ | | `prototype` | [`WritableStreamDefaultController`](internal-8.md#writablestreamdefaultcontroller) | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:246 packages/medusa-js/node_modules/@types/node/stream/web.d.ts:249 ___ ### WritableStreamDefaultWriter • **WritableStreamDefaultWriter**: `Object` #### Call signature • **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](internal-8.md#writablestreamdefaultwriter)<`W`\> ##### Type parameters | Name | Type | | :------ | :------ | | `W` | `any` | ##### Parameters | Name | Type | | :------ | :------ | | `stream` | [`WritableStream`](internal-8.md#writablestream)<`W`\> | ##### Returns [`WritableStreamDefaultWriter`](internal-8.md#writablestreamdefaultwriter)<`W`\> #### Type declaration | Name | Type | | :------ | :------ | | `prototype` | [`WritableStreamDefaultWriter`](internal-8.md#writablestreamdefaultwriter)<`any`\> | #### Defined in packages/medusa-js/node_modules/@types/node/stream/web.d.ts:227 packages/medusa-js/node_modules/@types/node/stream/web.d.ts:236 ## Functions ### Error ▸ **Error**(`message?`): [`Error`](internal-8.md#error) #### Parameters | Name | Type | | :------ | :------ | | `message?` | `string` | #### Returns [`Error`](internal-8.md#error) #### Defined in docs-util/node_modules/typescript/lib/lib.es5.d.ts:1074 ___ ### Object ▸ **Object**(): `any` Provides functionality common to all JavaScript objects. #### Returns `any` #### Defined in docs-util/node_modules/typescript/lib/lib.es5.d.ts:157 ▸ **Object**(`value`): `any` Provides functionality common to all JavaScript objects. #### Parameters | Name | Type | | :------ | :------ | | `value` | `any` | #### Returns `any` #### Defined in docs-util/node_modules/typescript/lib/lib.es5.d.ts:158